From 518cd5218879038f246266f94af75c88ea864732 Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Fri, 7 Feb 2025 15:44:50 +0200 Subject: [PATCH] website: re-generate commons --- .../2019-07-22-qemu-arm-v2-8-0-7-released.mdx | 2 +- .../2019-11-04-qemu-arm-v2-8-0-8-released.mdx | 2 +- .../2020-07-01-qemu-arm-v2-8-0-9-released.mdx | 2 +- ...2020-10-14-qemu-arm-v2-8-0-10-released.mdx | 2 +- ...2020-12-20-qemu-arm-v2-8-0-11-released.mdx | 2 +- ...2021-02-02-qemu-arm-v2-8-0-12-released.mdx | 2 +- ...2021-10-17-qemu-arm-v2-8-0-13-released.mdx | 2 +- .../2022-01-13-qemu-arm-v6-2-0-1-released.mdx | 2 +- .../2022-01-19-qemu-arm-v6-2-0-2-released.mdx | 2 +- .../2022-05-04-qemu-arm-v7-0-0-1-released.mdx | 2 +- .../2022-09-06-qemu-arm-v7-1-0-1-released.mdx | 2 +- .../2023-01-31-qemu-arm-v7-2-0-1-released.mdx | 2 +- .../2023-09-03-qemu-arm-v7-2-5-1-released.mdx | 2 +- .../2024-04-02-qemu-arm-v8-2-2-1-released.mdx | 2 +- website/blog/_common/_download-analytics.mdx | 2 +- .../blog-post-release-part-1-liquid.mdx | 1 + .../_folders-hierarchies-linux.mdx | 0 .../_folders-hierarchies-macos.mdx | 0 .../_folders-hierarchies-windows.mdx | 0 website/docs/developer/_common/_content.mdx | 2 +- website/docs/getting-started/index.mdx | 6 +- website/docs/install/_common/_content.mdx | 8 +- website/docs/maintainer/_common/_content.mdx | 207 +++++++++--------- .../_common/_generate-top-commons.mdx | 17 ++ website/src/libs/dateYYYYMMDD.ts | 17 ++ 25 files changed, 161 insertions(+), 127 deletions(-) rename website/docs/{install/_project => _shared}/_folders-hierarchies-linux.mdx (100%) rename website/docs/{install/_project => _shared}/_folders-hierarchies-macos.mdx (100%) rename website/docs/{install/_project => _shared}/_folders-hierarchies-windows.mdx (100%) create mode 100644 website/docs/maintainer/_common/_generate-top-commons.mdx create mode 100644 website/src/libs/dateYYYYMMDD.ts diff --git a/website/blog/2019-07-22-qemu-arm-v2-8-0-7-released.mdx b/website/blog/2019-07-22-qemu-arm-v2-8-0-7-released.mdx index ed88198..2c972fa 100644 --- a/website/blog/2019-07-22-qemu-arm-v2-8-0-7-released.mdx +++ b/website/blog/2019-07-22-qemu-arm-v2-8-0-7-released.mdx @@ -46,7 +46,7 @@ The binary files are available from GitHub Re The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2019-11-04-qemu-arm-v2-8-0-8-released.mdx b/website/blog/2019-11-04-qemu-arm-v2-8-0-8-released.mdx index ac091aa..61ce456 100644 --- a/website/blog/2019-11-04-qemu-arm-v2-8-0-8-released.mdx +++ b/website/blog/2019-11-04-qemu-arm-v2-8-0-8-released.mdx @@ -46,7 +46,7 @@ The binary files are available from GitHub Re The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2020-07-01-qemu-arm-v2-8-0-9-released.mdx b/website/blog/2020-07-01-qemu-arm-v2-8-0-9-released.mdx index ec53a37..b32280e 100644 --- a/website/blog/2020-07-01-qemu-arm-v2-8-0-9-released.mdx +++ b/website/blog/2020-07-01-qemu-arm-v2-8-0-9-released.mdx @@ -55,7 +55,7 @@ The binary files are available from GitHub Re The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2020-10-14-qemu-arm-v2-8-0-10-released.mdx b/website/blog/2020-10-14-qemu-arm-v2-8-0-10-released.mdx index a72fe28..6f64e18 100644 --- a/website/blog/2020-10-14-qemu-arm-v2-8-0-10-released.mdx +++ b/website/blog/2020-10-14-qemu-arm-v2-8-0-10-released.mdx @@ -62,7 +62,7 @@ The binary files are available from GitHub Re The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2020-12-20-qemu-arm-v2-8-0-11-released.mdx b/website/blog/2020-12-20-qemu-arm-v2-8-0-11-released.mdx index 210429c..d87fbdd 100644 --- a/website/blog/2020-12-20-qemu-arm-v2-8-0-11-released.mdx +++ b/website/blog/2020-12-20-qemu-arm-v2-8-0-11-released.mdx @@ -62,7 +62,7 @@ The binary files are available from GitHub Re The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2021-02-02-qemu-arm-v2-8-0-12-released.mdx b/website/blog/2021-02-02-qemu-arm-v2-8-0-12-released.mdx index 08aa7c8..a1808ba 100644 --- a/website/blog/2021-02-02-qemu-arm-v2-8-0-12-released.mdx +++ b/website/blog/2021-02-02-qemu-arm-v2-8-0-12-released.mdx @@ -62,7 +62,7 @@ The binary files are available from GitHub Re The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2021-10-17-qemu-arm-v2-8-0-13-released.mdx b/website/blog/2021-10-17-qemu-arm-v2-8-0-13-released.mdx index 79f37d7..5bbd13f 100644 --- a/website/blog/2021-10-17-qemu-arm-v2-8-0-13-released.mdx +++ b/website/blog/2021-10-17-qemu-arm-v2-8-0-13-released.mdx @@ -79,7 +79,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2022-01-13-qemu-arm-v6-2-0-1-released.mdx b/website/blog/2022-01-13-qemu-arm-v6-2-0-1-released.mdx index 20184e7..6d6255e 100644 --- a/website/blog/2022-01-13-qemu-arm-v6-2-0-1-released.mdx +++ b/website/blog/2022-01-13-qemu-arm-v6-2-0-1-released.mdx @@ -81,7 +81,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2022-01-19-qemu-arm-v6-2-0-2-released.mdx b/website/blog/2022-01-19-qemu-arm-v6-2-0-2-released.mdx index 5f92a98..0616abc 100644 --- a/website/blog/2022-01-19-qemu-arm-v6-2-0-2-released.mdx +++ b/website/blog/2022-01-19-qemu-arm-v6-2-0-2-released.mdx @@ -81,7 +81,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2022-05-04-qemu-arm-v7-0-0-1-released.mdx b/website/blog/2022-05-04-qemu-arm-v7-0-0-1-released.mdx index e16ea32..d67e602 100644 --- a/website/blog/2022-05-04-qemu-arm-v7-0-0-1-released.mdx +++ b/website/blog/2022-05-04-qemu-arm-v7-0-0-1-released.mdx @@ -81,7 +81,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2022-09-06-qemu-arm-v7-1-0-1-released.mdx b/website/blog/2022-09-06-qemu-arm-v7-1-0-1-released.mdx index 3618133..80b3af8 100644 --- a/website/blog/2022-09-06-qemu-arm-v7-1-0-1-released.mdx +++ b/website/blog/2022-09-06-qemu-arm-v7-1-0-1-released.mdx @@ -85,7 +85,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2023-01-31-qemu-arm-v7-2-0-1-released.mdx b/website/blog/2023-01-31-qemu-arm-v7-2-0-1-released.mdx index 81f5254..19a4043 100644 --- a/website/blog/2023-01-31-qemu-arm-v7-2-0-1-released.mdx +++ b/website/blog/2023-01-31-qemu-arm-v7-2-0-1-released.mdx @@ -85,7 +85,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2023-09-03-qemu-arm-v7-2-5-1-released.mdx b/website/blog/2023-09-03-qemu-arm-v7-2-5-1-released.mdx index e4fd49f..2b0021f 100644 --- a/website/blog/2023-09-03-qemu-arm-v7-2-5-1-released.mdx +++ b/website/blog/2023-09-03-qemu-arm-v7-2-5-1-released.mdx @@ -86,7 +86,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/2024-04-02-qemu-arm-v8-2-2-1-released.mdx b/website/blog/2024-04-02-qemu-arm-v8-2-2-1-released.mdx index 359def4..b2d80ad 100644 --- a/website/blog/2024-04-02-qemu-arm-v8-2-2-1-released.mdx +++ b/website/blog/2024-04-02-qemu-arm-v8-2-2-1-released.mdx @@ -86,7 +86,7 @@ distributions they must be installed explicitly. The easiest way to install this specific version, is by using **xpm**: { -`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} -verbose +`xpm install @xpack-dev-tools/qemu-arm@${frontMatter.version}.${frontMatter.npm_subversion} --verbose `} Comprehensive instructions for installing **xPack QEMU Arm** on different platforms diff --git a/website/blog/_common/_download-analytics.mdx b/website/blog/_common/_download-analytics.mdx index f2417c5..37abcc9 100644 --- a/website/blog/_common/_download-analytics.mdx +++ b/website/blog/_common/_download-analytics.mdx @@ -12,7 +12,7 @@ import Image from '@theme/IdealImage'; - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/qemu-arm-xpack/total)](https://github.com/xpack-dev-tools/qemu-arm-xpack/releases) - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=qemu-arm-xpack) (grouped by release) - npmjs.com [@xpack-dev-tools/qemu-arm](https://www.npmjs.com/package/@xpack-dev-tools/qemu-arm) - - last week downloads [![NPM Downloads](https://img.shields.io/npm/dw/%40xpack-dev-tools%2Fqemu-arm)](https://www.npmjs.com/package/@xpack-dev-tools/qemu-arm/) + - last month downloads [![NPM Downloads](https://img.shields.io/npm/dw/%40xpack-dev-tools%2Fqemu-arm)](https://www.npmjs.com/package/@xpack-dev-tools/qemu-arm/) - total downloads [![NPM Downloads](https://img.shields.io/npm/d18m/%40xpack-dev-tools%2Fqemu-arm)](https://www.npmjs.com/package/@xpack-dev-tools/qemu-arm/) Credit to [Shields IO](https://shields.io) for the badges and to diff --git a/website/blog/_templates/blog-post-release-part-1-liquid.mdx b/website/blog/_templates/blog-post-release-part-1-liquid.mdx index 609c325..f99c383 100644 --- a/website/blog/_templates/blog-post-release-part-1-liquid.mdx +++ b/website/blog/_templates/blog-post-release-part-1-liquid.mdx @@ -1,4 +1,5 @@ --- + title: xPack {{packageConfig.longName}} v{{xpackVersion}} released seo_title: Version {{xpackVersion}} released description: Version {{xpackVersion}} is a TODO new/maintenance release. diff --git a/website/docs/install/_project/_folders-hierarchies-linux.mdx b/website/docs/_shared/_folders-hierarchies-linux.mdx similarity index 100% rename from website/docs/install/_project/_folders-hierarchies-linux.mdx rename to website/docs/_shared/_folders-hierarchies-linux.mdx diff --git a/website/docs/install/_project/_folders-hierarchies-macos.mdx b/website/docs/_shared/_folders-hierarchies-macos.mdx similarity index 100% rename from website/docs/install/_project/_folders-hierarchies-macos.mdx rename to website/docs/_shared/_folders-hierarchies-macos.mdx diff --git a/website/docs/install/_project/_folders-hierarchies-windows.mdx b/website/docs/_shared/_folders-hierarchies-windows.mdx similarity index 100% rename from website/docs/install/_project/_folders-hierarchies-windows.mdx rename to website/docs/_shared/_folders-hierarchies-windows.mdx diff --git a/website/docs/developer/_common/_content.mdx b/website/docs/developer/_common/_content.mdx index 6c12249..d327d26 100644 --- a/website/docs/developer/_common/_content.mdx +++ b/website/docs/developer/_common/_content.mdx @@ -159,7 +159,7 @@ commands. xpm/xPack actions and build configurations are supported in Visual Studio via the [xPack C/C++ Managed Build Tools](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack) extension. -With this extension installed, xpm/xPack actions can be very conveniently +With this extension installed, xpm actions can be very conveniently invoked via a single mouse click, for example: ![xpm actions](https://github.com/xpack/vscode-xpack-extension-ts/raw/master/assets/docs-images/xpack-actions.png) diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index e311647..c5c32c4 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -18,6 +18,9 @@ date: 2020-07-21 17:49:00 +0300 --- +import Documentation from '../_shared/_documentation.mdx'; +import ReleaseSchedule from '../_shared/_release-schedule.mdx'; + import UserDeveloperMaintainer from './_common/_user-developer-maintainer.mdx'; import License from './_common/_license.mdx'; import Credits from './_common/_credits.mdx'; @@ -26,9 +29,6 @@ import SupportAndFeedback from './_common/_support-and-feedback.mdx'; import ChangeLog from './_common/_change-log.mdx'; import Releases from './_common/_releases.mdx'; -import Documentation from '../_shared/_documentation.mdx'; -import ReleaseSchedule from '../_shared/_release-schedule.mdx'; - import MoreCredits from './_project/_more-credits.mdx'; import Status from './_project/_status.mdx'; diff --git a/website/docs/install/_common/_content.mdx b/website/docs/install/_common/_content.mdx index 149d842..7ea5214 100644 --- a/website/docs/install/_common/_content.mdx +++ b/website/docs/install/_common/_content.mdx @@ -8,13 +8,13 @@ import Admonition from '@theme/Admonition'; import LinksVsForwarders from '@site/src/components/LinksVsForwarders'; +import FoldersHierarchiesLinux from '../../_shared/_folders-hierarchies-linux.mdx'; +import FoldersHierarchiesWindows from '../../_shared/_folders-hierarchies-windows.mdx'; +import FoldersHierarchiesMacOS from '../../_shared/_folders-hierarchies-macos.mdx'; + import AutomaticInstallQuickTest from '../_common/_automatic-install-quick-test.mdx'; import ManualInstallQuickTest from '../_common/_manual-install-quick-test.mdx'; -import FoldersHierarchiesLinux from '../_project/_folders-hierarchies-linux.mdx'; -import FoldersHierarchiesWindows from '../_project/_folders-hierarchies-windows.mdx'; -import FoldersHierarchiesMacOS from '../_project/_folders-hierarchies-macos.mdx'; - import Miscellaneous from '../_project/_miscellaneous.mdx'; import Testing from '../_project/_testing.mdx'; diff --git a/website/docs/maintainer/_common/_content.mdx b/website/docs/maintainer/_common/_content.mdx index f8e72d4..71cba39 100644 --- a/website/docs/maintainer/_common/_content.mdx +++ b/website/docs/maintainer/_common/_content.mdx @@ -8,6 +8,7 @@ import CodeBlock from '@theme/CodeBlock'; import customField from '@site/src/libs/customField'; import isXpackSubversionDouble from '@site/src/libs/isXpackSubversionDouble'; +import dateYYYYMMDD from '@site/src/libs/dateYYYYMMDD'; import ReleaseSchedule from '../../_shared/_release-schedule.mdx'; import GitHubActionsDurations from '../../_shared/_github-actions-durations.mdx'; @@ -15,6 +16,7 @@ import {developmentDurations} from '../../_shared/_development-durations.mdx'; import PlatformNativeBuild from '../_common/_platform-native-build.mdx'; import PlatformDockerBuild from '../_common/_platform-docker-build.mdx'; +import GenerateTopCommons from '../_common/_generate-top-commons.mdx'; import MoreRepos from '../_project/_more-repos.mdx'; import CheckUpstreamRelease from '../_project/_check-upstream-release.mdx'; @@ -117,8 +119,8 @@ In the `xpack-dev-tools/qemu-arm-xpack` Git repo: - switch to the `xpack-development` branch - pull new changes -- if necessary, merge the `xpack` branch -- if necessary, merge the `website` branch +- if necessary, **merge** the `xpack` branch +- if necessary, **merge** the `website` branch :::caution @@ -156,13 +158,20 @@ is 8.2.6-1. - update the release specific properties (if any) + + ### Update the website commons -Run the `website-generate-commons` actions from `website`. +Run the **generate-website-commons** npm script from `website/package.json`. + +### Commit the website changes + +- **stage** `website` and top `README.md` +- **commit** with the message _**website: re-generate commons**_ ### Start the local web server -Execute the npm script `clean` then `start` in the website sub-project, +Execute the npm script **clean** then **start** in the website sub-project, or run the following in a terminal: ```sh @@ -170,7 +179,7 @@ or run the following in a terminal: ``` Navigate to the **Maintainer Info** page, -the **Update the version specific code** section. +the **[Update the version specific code](http://localhost:3000/openocd-xpack/docs/maintainer/#update-the-version-specific-code)** section. @@ -185,42 +194,34 @@ and fix them; assign them to a milestone (like 8.2.6-1). ### Update `CHANGELOG.md` -To turn the dates into headings, change from: - -```txt - - -([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]) [*] -``` - -to: - -```txt - - -## $1 - -* -``` +- 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 +- to turn the dates into headings, change from: + ```txt -To remove the rest of the dates, change from: -```txt -^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [*] -``` + ([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]) [*] + ``` + to: + ```txt -to: -```txt -* -``` + ## $1 -- 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 + * + ``` +- to remove the rest of the dates, change from: + ```txt + ^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [*] + ``` + to: + ```txt + * + ``` - add a new entry like _**\* v8.2.6-1 prepared**_ -- commit with the message _**prepare v8.2.6-1**_ +- **commit** with the message _**prepare v8.2.6-1**_ ### Push the changes to the `xpack-development` branch @@ -270,6 +271,13 @@ Check if both the **current project** and the **helper** are on the `xpack-development` branch and the latest commits are pushed to GitHub. +:::caution + +This is particularly crucial for extensive projects; otherwise, +the build may proceed with the previous version. + +::: + ### Build the x64 macOS binaries For x64 macOS, first run the build on the development machine @@ -303,7 +311,7 @@ xpm run build-development-debug --config darwin-x64 -C ~/Work/xpack-dev-tools/qe The build takes {developmentDurations["work"]} to complete. -When functional, push the `xpack-development` branch to GitHub. +When functional, **push** the `xpack-development` branch to GitHub. Run the native build on the production machine (`xbbmi`, an older macOS); @@ -383,9 +391,9 @@ Commit with the message _**website: update development durations**_. Copy the trees displayed at the end of the test builds and paste to **Folder hierarchy** section in the web file: -- `website/docs/install/_project/_folders-hierarchies-linux.mdx` -- `website/docs/install/_project/_folders-hierarchies-macos.mdx` -- `website/docs/install/_project/_folders-hierarchies-windows.mdx` +- `website/docs/_shared/_folders-hierarchies-linux.mdx` +- `website/docs/_shared/_folders-hierarchies-macos.mdx` +- `website/docs/_shared/_folders-hierarchies-windows.mdx` If present, replace the actual version (like **8.2.6**) with the following expression: @@ -420,8 +428,8 @@ In some cases it is necessary to run a debug session with the binaries. For these cases, the build script accepts the `--debug` options. -There are also xpm actions that use this option (`build-development-debug` -and `docker-build-development-debug`). +There are also xpm actions that use this option (**build-development-debug** +and **docker-build-development-debug**). ### Files cache @@ -519,18 +527,7 @@ Publish a new release of the helper on **npmjs**. In `templates/_xpack-dev-tools/build-assets/package-merge-liquid.json`, update the reference to `"@xpack-dev-tools/xbb-helper":`. -### Generate the top commons - -Run the top **generate-top-commons** npm script to update the -`build-assets/package.json` and the GitHub workflow files. - -```sh -npm run generate-top-commons -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git -``` - -### Commit the changes - -Commit with the message _**re-generate top commons**_. + ### Check for disk space @@ -577,8 +574,11 @@ rm -rf ~/Work/xpack-dev-tools/*/build-assets/build ### Commit and push -- commit with the message **re-generate workflows** -- push the `xpack-development` branch to GitHub +- **push** the `xpack-development` branch to GitHub + +### Check if the helper is pushed and published + +The helper `xpack` branch must be updated and the npm package published. @@ -672,7 +672,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** xpm/xPack action: +To trigger the Travis test, run the **trigger-travis-macos** xpm action: ```sh xpm run trigger-travis-macos -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets @@ -714,14 +714,13 @@ xattr -cr ${HOME}/Downloads/xpack-* - in `CHANGELOG.md`, add the release date and a message like _**\* v8.2.6-1 released**_ -- commit with the message _**CHANGELOG update**_ +- **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** xpm/xPack action: - -```sh -xpm run trigger-workflow-publish-release -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets -``` +- **push** the `xpack-development` branch to GitHub +- run the **trigger-workflow-publish-release** xpm action: + ```sh + xpm run trigger-workflow-publish-release -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets + ``` The workflow result and logs are available from the [GitHub Actions](https://github.com/xpack-dev-tools/qemu-arm-xpack/actions) page. @@ -734,6 +733,10 @@ with all binaries attached. - edit the draft and be sure it is attached to the `xpack-development` branch (important!) - perform the final edits (maintenance vs. new release) and check if everything is fine +- add entries in the **Bug fixes**; use the following syntax + ``` + - [[#N](https://github.com/xpack-dev-tools/qemu-arm-xpack/issues/N)]: + ``` - **keep the pre-release button enabled** - do **not** enable Discussions yet - click the **Publish release** button @@ -748,23 +751,22 @@ watching the qemu-arm-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** xpm/xPack action; +- run the **generate-website-blog-post** xpm action; this will add a file in the `website/blog` folder: - -```sh -xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets -``` - -- edit the front matter properties -- select the correct summary -- commit with the message _**website: blog post release 8.2.6-1 published**_ + ```sh + xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets + ``` +- edit the `description` property in the post front matter +- select the correct summary (maintenance vs. new release) +- copy/paste the folders hierarchies from the install guide +- **commit** with the message _**website: blog post release 8.2.6-1 published**_ ### Update the web install page - check and possibly update the output of the `--version` runs in - `website/docs/install/_project/_automatic-install-quick-test.mdx` - `website/docs/install/_project/_manual-install-quick-test.mdx` -- commit with the message _**website: update quick tests**_ +- **commit** with the message _**website: update quick tests**_ ### Check the list of links in top package.json @@ -776,19 +778,17 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/ - select the `xpack-development` branch - be sure that the binaries were attached to the pre-release -- run the **update-package-binaries** xpm/xPack action: - -```sh -xpm run update-package-binaries -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets -``` - +- run the **update-package-binaries** xpm action: + ```sh + xpm run update-package-binaries -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets + ``` - open the top `package.json` file - check the `baseUrl:` it should match the file URLs (including the tag/version); no terminating `/` is required - from the release, check the SHA & file names - compare the SHA sums with those shown by `cat *.sha` - check the executable names -- commit all changes with the message +- **commit** all changes with the message _**package.json: update urls for 8.2.6-1.1 release**_ ### Publish on the npmjs.com server @@ -796,37 +796,32 @@ xpm run update-package-binaries -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/bui - select the `xpack-development` branch - check the latest commits `xpm run git-log` - update `CHANGELOG.md`, add a line like _**\* v8.2.6-1.1 published on npmjs.com**_ -- commit with the message _**CHANGELOG: publish npm v8.2.6-1.1**_ +- **commit** with the message _**CHANGELOG: publish npm v8.2.6-1.1**_ - `npm pack` and check the content of the archive, which should list only the `package.json`, the `README.md`, `LICENSE` and `CHANGELOG.md`; possibly adjust `.npmignore` - configure the version; the first 4 numbers are the same as the GitHub release; the fifth number is the npm specific version: - - { -`npm version 8.2.6-1.1 -`} - + ```sh + npm version 8.2.6-1.1 + ``` - the commits and the tag should have been pushed by the `postversion` script; if not, push them with `git push origin --tags` to GitHub - publish and add the `test` tag: - -```sh -npm publish --tag test -``` - + ```sh + npm publish --tag test + ``` - when publishing for the first time, use: - -```sh -npm publish --access public -``` + ```sh + npm publish --access public + ``` After a few moments the version will be visible at npmjs.com. ### Test if the binaries can be installed with xpm -Run the **trigger-workflow-test-xpm** xpm/xPack action: +Run the **trigger-workflow-test-xpm** xpm action: ```sh xpm run trigger-workflow-test-xpm -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets @@ -862,7 +857,7 @@ 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 run build -C website +(cd website; npm run build) ``` ### Publish the website @@ -870,17 +865,20 @@ npm run build -C website - open https://xpack-dev-tools.github.io/qemu-arm-xpack/docs/maintainer/#publish-the-website in a separate window - stop the local web server - select the `website` branch -- merge `xpack-development` into `website` -- push the `website` branch to GitHub +- **merge** `xpack-development` into `website` +- **push** the `website` branch to GitHub :::info At this moment an automated GitHub Action will generate and publish the website. ::: -- add a new tag like `web-YYYYMMDD` +- if already there from a previous run, delete the web-{dateYYYYMMDD()} tag, including from remote +- add a new tag like web-{dateYYYYMMDD()} and push it to remote +- checkout the `xpack-development` branch +- wait for the publish to complete +- refresh the web page - the new release blog post is in https://xpack-dev-tools.github.io/qemu-arm-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/qemu-arm-xpack/docs/maintainer/#update-the-xpack-branch The `website` branch may be subsequently updated, as long as the version in the top `package.json` is not changed. @@ -890,8 +888,9 @@ version in the top `package.json` is not changed. In this Git repo: - select the `xpack` branch -- merge `xpack-development` into `xpack` -- push the `xpack` branch to GitHub +- **merge** `xpack-development` into `xpack` +- **push** the `xpack` branch to GitHub +- checkout the `xpack-development` branch :::note @@ -922,7 +921,7 @@ Avoid further updates to the `xpack` branch until the next release. ### Clean the work area -Run the **trigger-workflow-deep-clean** xpm/xPack action +Run the **trigger-workflow-deep-clean** xpm action: ```sh xpm run trigger-workflow-deep-clean -C ~/Work/xpack-dev-tools/qemu-arm-xpack.git/build-assets diff --git a/website/docs/maintainer/_common/_generate-top-commons.mdx b/website/docs/maintainer/_common/_generate-top-commons.mdx new file mode 100644 index 0000000..139038e --- /dev/null +++ b/website/docs/maintainer/_common/_generate-top-commons.mdx @@ -0,0 +1,17 @@ + +{/* ------------------------------------------------------------------------ */} + +### Generate the top commons + +Run the top **generate-top-commons** npm script to update the +`build-assets/package.json` and the GitHub workflow files. + +```sh +(cd ~/Work/xpack-dev-tools/qemu-arm-xpack.git; npm run generate-top-commons) +``` + +### Commit the top changes + +- stage GitHub workflows and `package.json` files (top and from `build-assets`) +- **commit** with the message _**re-generate top commons to bump deps**_ + diff --git a/website/src/libs/dateYYYYMMDD.ts b/website/src/libs/dateYYYYMMDD.ts new file mode 100644 index 0000000..80917be --- /dev/null +++ b/website/src/libs/dateYYYYMMDD.ts @@ -0,0 +1,17 @@ +/* + * DO NOT EDIT! + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. + * + * This file is part of the xPack project (http://xpack.github.io). + * Copyright (c) 2024 Liviu Ionescu. All rights reserved. + * + * Permission to use, copy, modify, and/or distribute this software + * for any purpose is hereby granted, under the terms of the MIT license. + * + * If a copy of the license was not distributed with this file, it can + * be obtained from https://opensource.org/licenses/MIT/. + */ + +export default function dateYYYYMMDD(): string { + return (new Date()).toISOString().slice(0,10).replace(/-/g,""); +}