docs: version only major bumps (#736)

Only major versions are now producing docs snapshots. On release, old
version is removed and generated from scratch, so it always reflects the
latest stable one.

<img width="512" height="171" alt="image"
src="https://github.com/user-attachments/assets/eee5ac65-8002-4525-8292-ac6fa5583743"
/>

I am sure this could be done in another way, feels a bit hacky, but it
works 🙃

Closes apify/apify-docs#1837

---------

Co-authored-by: Jan Buchar <[email protected]>

Author: B4nan

.github/workflows/release.yaml

@@ -121,6 +121,51 @@ jobs:
             - name: Publish to NPM
               run: npm publish --tag latest
 
+    version-docs:
+        needs: publish_to_npm
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v5
+              with:
+                  ref: ${{ github.event.repository.default_branch }}
+                  token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
+                  fetch-depth: 0
+
+            - name: Use Node.js 22
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 22
+                  cache: 'npm'
+
+            - name: Install jq
+              run: sudo apt-get install jq
+
+            - name: Install dependencies
+              run: |
+                  npm install
+                  cd website
+                  npm install
+
+            - name: Snapshot the current version
+              run: |
+                  cd website
+                  VERSION=$(jq -r '.version' ../package.json)
+                  export MAJOR=$(echo $VERSION | cut -d. -f1)
+                  rm -rf versioned_docs/version-$MAJOR
+                  rm -rf versioned_sidebars/version-$MAJOR-sidebars.json
+                  jq 'map(select(. != env.MAJOR))' versions.json > tmp.json && mv tmp.json versions.json
+                  npx docusaurus docs:version $MAJOR
+                  npx docusaurus api:version $MAJOR
+
+            - name: Commit and push the version snapshot
+              uses: EndBug/add-and-commit@v9
+              with:
+                  author_name: Apify Release Bot
+                  author_email: [email protected]
+                  message: 'docs: update docs for ${{ inputs.version }} version'
+
 env:
     NODE_AUTH_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_NPM_TOKEN }}
     NPM_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_NPM_TOKEN }}

website/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.js

@@ -5,6 +5,7 @@ import { translate } from '@docusaurus/Translate';
 import { useLocation } from '@docusaurus/router';
 import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
 import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
+import pkg from '../../../../package.json';
 
 const getVersionMainDoc = (version) => version.docs.find((doc) => doc.id === version.mainDocId);
 
@@ -35,12 +36,14 @@ export default function DocsVersionDropdownNavbarItem({
     const activeDocContext = useActiveDocContext(docsPluginId);
     const versions = useVersions(docsPluginId);
     const { savePreferredVersionName } = useDocsPreferredVersion(docsPluginId);
+    const currentMajor = pkg.version.split('.')[0];
     const versionLinks = versions.map((version, idx) => {
         // We try to link to the same doc, in another version
         // When not possible, fallback to the "main doc" of the version
         const versionDoc = activeDocContext.alternateDocVersions[version.name] ?? getVersionMainDoc(version);
+        const label = version.label === currentMajor ? pkg.version : version.label;
         return {
-            label: version.label,
+            label,
             // preserve ?search#hash suffix on version switches
             to: `${apiLinks[idx] ?? versionDoc.path}${search}${hash}`,
             isActive: () => version === activeDocContext.activeVersion,
@@ -57,7 +60,9 @@ export default function DocsVersionDropdownNavbarItem({
                   message: 'Versions',
                   description: 'The label for the navbar versions dropdown on mobile view',
               })
-            : dropdownVersion.label;
+            : dropdownVersion.label === currentMajor
+              ? pkg.version
+              : dropdownVersion.label;
     let dropdownTo = mobile && items.length > 1 ? undefined : getVersionMainDoc(dropdownVersion).path;
 
     if (dropdownTo && pathname.startsWith('/api/client/js/reference')) {