Skip to content

ci: fix version_docs workflow for pnpm workspace setup #1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
l2ysho merged 16 commits into from
May 6, 2026
Merged

ci: fix version_docs workflow for pnpm workspace setup #1124

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2a206f7
ci: change pnpm exec to run
l2ysho May 5, 2026
58bf5d6
fix
l2ysho May 5, 2026
0d4829f
fix
l2ysho May 5, 2026
20826ad
fix path
l2ysho May 5, 2026
a42f448
skip prettier
l2ysho May 5, 2026
e844500
Merge branch 'master' into fix-version-docs-workflow
l2ysho May 5, 2026
a24d714
facepalm
l2ysho May 5, 2026
b5d2302
add workspace name for website
l2ysho May 5, 2026
7f6fed6
prevent website/pnpm-lock.yaml problem
l2ysho May 5, 2026
ab39e74
drop useless prettier
l2ysho May 6, 2026
6ca48fe
Merge branch 'master' into fix-version-docs-workflow
l2ysho May 6, 2026
34b8d40
fix docs workflow
l2ysho May 6, 2026
acbdedf
add [docs build]
l2ysho May 6, 2026
ca00e5a
Merge branch 'master' into fix-version-docs-workflow
l2ysho May 6, 2026
8a26948
update conditions
l2ysho May 6, 2026
e26827b
fix names
l2ysho May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,10 @@ jobs:
run: |
# update next docs reference
pnpm run update-docs
# go to website dir
cd website
# install website deps
pnpm install
# install the latest theme version
pnpm add @apify/docs-theme@latest
pnpm --filter apify-cli-website add @apify/docs-theme@latest
# build the docs
pnpm run build
pnpm --filter apify-cli-website run build
env:
SMARTLOOK_PROJECT_KEY: ${{ secrets.SMARTLOOK_DOCS_PROJECT_KEY }}
GIT_USER: "apify-service-account:${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}"
Expand All @@ -56,7 +52,7 @@ jobs:
uses: stefanzweifel/git-auto-commit-action@v7
with:
commit_message: "chore: Automatic theme updating workflow [skip ci]"
file_pattern: "website/package*.json website/pnpm-lock.yaml"
file_pattern: "website/package*.json pnpm-lock.yaml"
commit_user_name: Apify Bot
commit_user_email: my-github-actions-bot@example.org
commit_author: Apify Bot <apify@apify.com>
Expand Down
17 changes: 8 additions & 9 deletions .github/workflows/version_docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,19 @@ jobs:
VERSION=$(jq -r '.version' package.json)
MAJOR_MINOR=$(echo "$VERSION" | cut -d. -f1,2)
echo "version=$VERSION" >> $GITHUB_OUTPUT
cd website
rm -rf versioned_docs/version-$MAJOR_MINOR
rm -rf versioned_sidebars/version-$MAJOR_MINOR-sidebars.json
jq --arg v "$MAJOR_MINOR" 'map(select(. != $v))' versions.json > tmp.json && mv tmp.json versions.json
pnpm exec docusaurus docs:version $MAJOR_MINOR
rm -rf website/versioned_docs/version-$MAJOR_MINOR
rm -rf website/versioned_sidebars/version-$MAJOR_MINOR-sidebars.json
jq --arg v "$MAJOR_MINOR" 'map(select(. != $v))' website/versions.json > website/tmp.json && mv website/tmp.json website/versions.json
pnpm --filter apify-cli-website exec -- docusaurus docs:version $MAJOR_MINOR
Copy link
Copy Markdown
Member

@vladfrangu vladfrangu May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it apify-cli-website or just website 👁️

Copy link
Copy Markdown
Contributor Author

@l2ysho l2ysho May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apify-cli-website ->

apify-cli/website/package.json

Line 2 in 8a26948

"name": "apify-cli-website",
(idea stolen from client-js)

Copy link
Copy Markdown
Member

@vladfrangu vladfrangu May 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, then gotta change it in the other workflow 🙏

Copy link
Copy Markdown
Contributor Author

@l2ysho l2ysho May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dammit claude, i said make no mistake...

Copy link
Copy Markdown
Contributor Author

@l2ysho l2ysho May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅


- name: Format
working-directory: website
run: pnpm run prettify
# TODO: prettify script references docs/guides/*.md which doesn't exist — check with team
# - name: Format
# run: pnpm --filter apify-cli-website run prettify
Copy link
Copy Markdown
Member

@B4nan B4nan May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd just drop this for now


- name: Commit and push the version snapshot
uses: EndBug/add-and-commit@v10
with:
author_name: Apify Release Bot
author_email: noreply@apify.com
message: "docs: version docs for ${{ steps.version.outputs.version }} [skip ci]"
Copy link
Copy Markdown
Member

@vladfrangu vladfrangu May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think skip ci is more meant for our tests and pre-releases, those don't need to trigger CI. Can you update the docs building workflow instead to not ignore skip ci commits? :D

Copy link
Copy Markdown
Contributor Author

@l2ysho l2ysho May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah but then you have to know that [skip ci] is actually [skip ci but not docs build] under surface :]

message: "docs: version docs for ${{ steps.version.outputs.version }}"
pull: "--rebase --autostash"
2 changes: 2 additions & 0 deletions website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"name": "apify-cli-website",
"private": true,
"scripts": {
"examples": "docusaurus-examples",
"start": "rimraf .docusaurus && docusaurus start",
Expand Down
Loading
Loading