website: updates

xpack-dev-tools · Jan 2, 2025 · f6f1546 · f6f1546
1 parent 358b5e4
commit f6f1546
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 41 deletions.
diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx
@@ -186,14 +186,14 @@ xpm/xPack actions and build configurations are supported in Visual Studio via th
 With this extension installed, xpm/xPack actions can be very conveniently
 invoked via a single mouse click, for example:
 
-![xPack actions](https://github.com/xpack/vscode-xpack-extension-ts/raw/master/assets/docs-images/xpack-actions.png)
+![xpm actions](https://github.com/xpack/vscode-xpack-extension-ts/raw/master/assets/docs-images/xpack-actions.png)
 
 </details>
 
 ## Prerequisites
 
 The build scripts run on GNU/Linux and macOS. The Windows binaries are
-compiled on x64 GNU/Linux, using [mingw-w64](https://mingw-w64.org).
+compiled on GNU/Linux, using [mingw-w64](https://mingw-w64.org).
 
 For details on installing the prerequisites, please read the
 [Build Prerequisites](https://xpack-dev-tools.github.io/docs/developer/install/prerequisites/)

diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx
@@ -220,13 +220,6 @@ and fix them; assign them to a milestone (like <code>{customField('xpackVersion'
 
 ### Update `CHANGELOG.md`
 
-- open the `CHANGELOG.md` file
-- check if all previous fixed issues are in
-- check the latest commits `xpm run git-log`; if necessary, copy/paste lines,
-  group by dates and edit them using the below regular expressions
-- add a new entry like _**\* v{customField('xpackVersion')} prepared**_
-- commit with the message _**prepare v{customField('xpackVersion')}**_
-
 To turn the dates into headings, change from:
 
 ```txt
@@ -257,6 +250,14 @@ to:
 *
 ```
 
+- open the `CHANGELOG.md` file
+- check if all previous fixed issues are in
+- check the latest commits `xpm run git-log`; if necessary, copy/paste lines,
+  group by dates and edit them using the below regular expressions
+- add a new entry like _**\* v{customField('xpackVersion')} prepared**_
+- commit with the message _**prepare v{customField('xpackVersion')}**_
+
+
 ### Push the changes to the `xpack-development` branch
 
 Be sure that the latest commit that updates `VERSION` is pushed
@@ -584,7 +585,7 @@ rm -rf ~/Work/xpack-dev-tools/*/build-assets/build
 
 ### Generate the GitHub workflows
 
-Run the **generate-workflows** xPack action to update the
+Run the **generate-workflows** xpm/xPack action to update the
 GitHub workflow files.
 
 ```sh
@@ -619,7 +620,7 @@ xpm run trigger-workflow-build-linux-arm64 -C ~/Work/xpack-dev-tools/arm-none-ea
 xpm run trigger-workflow-build-linux-arm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
 ```
 
-The scripts behind these actions require the `XPACK_DEV_TOOLS_FG_DISPATCH_TOKEN`
+The scripts behind these actions require the `GITHUB_API_DISPATCH_TOKEN`
 variable to be present
 in the environment, and the organization `PUBLISH_TOKEN` to be visible in the
 Settings → Action →
@@ -663,7 +664,7 @@ xpm run trigger-workflow-test-docker-linux-x64 -C ~/Work/xpack-dev-tools/arm-non
 xpm run trigger-workflow-test-docker-linux-arm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
 ```
 
-The scripts behind these accessible require the `XPACK_DEV_TOOLS_FG_DISPATCH_TOKEN` variable to be present
+The scripts behind these accessible require the `GITHUB_API_DISPATCH_TOKEN` variable to be present
 in the environment.
 
 These actions use the `xpack-development` branch of this repo and the
@@ -688,7 +689,7 @@ with previous runs.
 Since GitHub Actions provides a limited range of versions for the macOS
 runner, the multi-version macOS tests run on Travis.
 
-To trigger the Travis test, run the **trigger-travis-macos** xPack action:
+To trigger the Travis test, run the **trigger-travis-macos** xpm/xPack action:
 
 ```sh
 xpm run trigger-travis-macos -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -733,7 +734,7 @@ xattr -cr ${HOME}/Downloads/xpack-*
 - commit with the message _**CHANGELOG update**_
 - check and possibly update the `build-assets/templates/body-github-release-liquid.mdx`
 - push the `xpack-development` branch to GitHub
-- run the **trigger-workflow-publish-release** xPack action:
+- run the **trigger-workflow-publish-release** xpm/xPack action:
 
 ```sh
 xpm run trigger-workflow-publish-release -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -754,13 +755,17 @@ with all binaries attached.
 - do **not** enable Discussions yet
 - click the **Publish release** button
 
-Note: at this moment the system should send a notification to all clients
-watching this project.
+:::info
+
+At this moment the system should send an email notification to all clients
+watching the arm-none-eabi-gcc-xpack project.
+
+:::
 
 ### Prepare a new blog post
 
 - check and possibly update the `website/blog/_templates/blog-post-release-part-[12]-liquid.md`
-- run the **generate-website-blog-post** xPack action;
+- run the **generate-website-blog-post** xpm/xPack action;
 this will add a file in the `website/blog` folder:
 
 ```sh
@@ -769,7 +774,7 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-x
 
 - edit the front matter properties
 - select the correct summary
-- commit with the message _**blog post release {customField('xpackVersion')} published**_
+- commit with the message _**website: blog post release {customField('xpackVersion')} published**_
 
 ### Update the web install page
 
@@ -780,15 +785,15 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-x
 
 ### Check the list of links in top package.json
 
-- open the `package.json` file
+- open the top `package.json` file
 - check if the links in the `bin` property cover the actual binaries
 - if necessary, also check on Windows
 
 ### Update the package.json list of binaries
 
 - select the `xpack-development` branch
 - be sure that the binaries were attached to the pre-release
-- run the **update-package-binaries** xPack action:
+- run the **update-package-binaries** xpm/xPack action:
 
 ```sh
 xpm run update-package-binaries -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -838,7 +843,7 @@ After a few moments the version will be visible at
 
 ### Test if the binaries can be installed with xpm
 
-Run the **trigger-workflow-test-xpm** xPack action:
+Run the **trigger-workflow-test-xpm** xpm/xPack action:
 
 ```sh
 xpm run trigger-workflow-test-xpm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -855,10 +860,14 @@ The tests results are available from the
 
 When the release is considered stable, promote it as `latest`:
 
+<CodeBlock language="sh"> {
+`npm dist-tag add @xpack-dev-tools/arm-none-eabi-gcc@${customField('xpackVersion')}.${customField('npmSubversion')} latest
+`} </CodeBlock>
+
+Check the result:
+
 <CodeBlock language="sh"> {
 `npm dist-tag ls @xpack-dev-tools/arm-none-eabi-gcc
-npm dist-tag add @xpack-dev-tools/arm-none-eabi-gcc@${customField('xpackVersion')}.${customField('npmSubversion')} latest
-npm dist-tag ls @xpack-dev-tools/arm-none-eabi-gcc
 `} </CodeBlock>
 
 In case the release proves problematic and needs to be unpublished:
@@ -872,23 +881,26 @@ In case the release proves problematic and needs to be unpublished:
 Validate the web site content in a local build via the npm `build` script:
 
 ```sh
-npm --prefix website run build
+npm run build -C website
 ```
 
 ### Publish the website
 
+- stop the local web server
+- select the `website` branch
 - merge `xpack-development` into `website`
 - push the `website` branch to GitHub
-
-At this moment an automated GitHub Action will generate and publish the website.
-
+  :::info
+  At this moment an automated GitHub Action will generate and publish the website.
+  :::
 - the new release blog post is
 in https://xpack-dev-tools.github.io/arm-none-eabi-gcc-xpack/blog/
 - remember the post URL, since it must be used to update the release page
 and the X/Twitter announcement
+- switch to https://xpack-dev-tools.github.io/arm-none-eabi-gcc-xpack/docs/maintainer/#update-the-xpack-branch
 
 The `website` branch may be subsequently updated, as long as the
-version in `package.json` is not changed.
+version in the top `package.json` is not changed.
 
 ### Update the `xpack` branch
 
@@ -910,7 +922,8 @@ Avoid further updates to the `xpack` branch until the next release.
 - check the download counter, it should match the number of tests
 - add a link to the Web blog `[Continue reading »]()`; use an same blog URL
 - remove the _tests only_ notice
-- **disable** the **pre-release** button
+- **disable** the **Set as a pre-release** button
+- **enable** the **Set as the latest release** button
 - click the **Update Release** button
 
 ### Check SourceForge mirror
@@ -926,7 +939,7 @@ Avoid further updates to the `xpack` branch until the next release.
 
 ### Clean the work area
 
-Run the **trigger-workflow-deep-clean** xPack action
+Run the **trigger-workflow-deep-clean** xpm/xPack action
 
 ```sh
 xpm run trigger-workflow-deep-clean -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -937,6 +950,15 @@ This will remove the build folders on all self-hosted runners.
 The results are available from the
 [GitHub Actions](https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/actions/) page.
 
+### Close possible open issues
+
+Check GitHub issues and pull requests:
+
+- https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/issues
+- https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/pulls
+
+Close those that were addressed.
+
 ## Share on Twitter
 
 - in a separate browser windows, open [X/Twitter](https://twitter.com)

diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -335,19 +335,29 @@ const config: Config = {
           'aria-label': 'GitHub repository',
         },
         {
-          label: `v${customFields.xpackVersion}`,
-          position: 'right',
-          href: `https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/tag/v${customFields.xpackVersion}`,
-        },
-        {
-          href: 'https://github.com/xpack-dev-tools/',
-          label: 'xpack-dev-tools',
+          type: 'dropdown',
+          href: 'https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/',
           position: 'right',
+          label: 'GitHub',
+          items: [
+            {
+              label: `arm-none-eabi-gcc-xpack`,
+              href: `https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/`,
+            },
+            {
+              label: 'xpack-dev-tools org',
+              href: 'https://github.com/xpack-dev-tools/',
+            },
+            {
+              label: 'xpack org',
+              href: 'https://github.com/xpack/',
+            },
+          ]
         },
         {
-          href: 'https://github.com/xpack/',
-          label: 'xpack',
+          label: `${customFields.xpackVersion}`,
           position: 'right',
+          href: `https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/tag/v${customFields.xpackVersion}`,
         },
       ],
     },
@@ -408,11 +418,11 @@ const config: Config = {
               href: 'https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/',
             },
             {
-              label: 'GitHub xpack-dev-tools',
+              label: 'GitHub xpack-dev-tools org',
               href: 'https://github.com/xpack-dev-tools/',
             },
             {
-              label: 'GitHub xpack',
+              label: 'GitHub xpack org',
               href: 'https://github.com/xpack/',
             },
           ],