From b6afa5226a76c3cf29ca2976325f2c325a79722e Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Mon, 3 Feb 2025 22:44:29 +0200 Subject: [PATCH] website: re-generate commons --- website/docs/maintainer/_common/_content.mdx | 60 ++++++++++---------- website/package.json | 6 +- website/src/css/custom.css | 24 ++++---- 3 files changed, 46 insertions(+), 44 deletions(-) diff --git a/website/docs/maintainer/_common/_content.mdx b/website/docs/maintainer/_common/_content.mdx index 820d333..22235c5 100644 --- a/website/docs/maintainer/_common/_content.mdx +++ b/website/docs/maintainer/_common/_content.mdx @@ -143,13 +143,22 @@ update the dependencies in `build-assets/package.json`. - use the new version, suffixed by `.pre`, like 3.29.9-1.1.pre. +### Increase the version and update VERSION + +Determine the version (like 3.29.9-1) +and update the `build-assets/scripts/VERSION` file; the format +is 3.29.9-1. +{isXpackSubversionDouble() ? +'The fourth & fifth numbers are the xPack release number of this version. A sixth' : +'The fourth number is the xPack release number of this version. A fifth'} number will be added to the version in `package.json` when the package is published to the `npm` server. + ### Update the `websiteConfig` in `website/package.json` (if necessary) -Update the custom fields. +- update the release specific properties (if any) ### Update the website commons -Run the `website-generate-commons` actions from `build-assets`. +Run the `website-generate-commons` actions from `website`. ### Start the local web server @@ -163,20 +172,6 @@ or run the following in a terminal: Navigate to the **Maintainer Info** page, the **Increase the version and update VERSION** section. -### Increase the version and update VERSION - -Determine the version (like 3.29.9-1) -and update the `build-assets/scripts/VERSION` file; the format -is 3.29.9-1. -{isXpackSubversionDouble() ? -'The fourth & fifth numbers are the xPack release number of this version. A sixth' : -'The fourth number is the xPack release number of this version. A fifth'} number will be added to the version in `package.json` when the package is published to the `npm` server. - -### Update the `websiteConfig` in `website/package.json` (if necessary) - -- update the release specific properties (if any) -- restart the local web server - ### Fix possible open issues @@ -271,7 +266,7 @@ sudo systemctl restart docker ### Check if both projects are pushed -Check if both the current project and the helper are +Check if both the **current project** and the **helper** are on the `xpack-development` branch and the latest commits are pushed to GitHub. @@ -378,7 +373,7 @@ caffeinate ssh xbbla32 ### Update the durations of the development builds -In `website/docs/maintainer/_development-durations.mdx`, update +In `website/docs/maintainer/_shared/_development-durations.mdx`, update the durations of the builds. Commit with the message _**website: update development durations**_. @@ -388,9 +383,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/_folders-hierarchies-linux.mdx` -- `website/docs/install/_folders-hierarchies-macos.mdx` -- `website/docs/install/_folders-hierarchies-windows.mdx` +- `website/docs/install/_project/_folders-hierarchies-linux.mdx` +- `website/docs/install/_project/_folders-hierarchies-macos.mdx` +- `website/docs/install/_project/_folders-hierarchies-windows.mdx` If present, replace the actual version (like **3.29.9**) with the following expression: @@ -407,6 +402,7 @@ via HomeBrew, and make a link to `/usr/local/bin`. ::: + Commit with the message _**website: update folder hierarchies**_. ### Update the list of links in top package.json @@ -446,6 +442,9 @@ The automation is provided by GitHub Actions and three self-hosted runners. ### Start the self-hosted runners +If the runners expired (more than 2 weeks since last use), run the +`github-runner-configure.sh` script to reconfigure them + - on the development machine (`wksi`) open ssh sessions to the build machines (`xbbli`, `xbbmi`, `xbbma`, `xbbla`, `xbbla32`): @@ -499,15 +498,14 @@ The status of all self-hosted runners is available at the [GitHub Runners](https Publish a new release of the helper on **npmjs**. -### Update the dependency to the new helper +### In `npm-packages-helper.git`, update the dependency to the new helper -In `build-assets/package.json`, update the reference -to `"@xpack-dev-tools/xbb-helper":` -(possibly in all xPack projects). +In `templates/_xpack-dev-tools/build-assets/package-merge-liquid.json`, update the reference +to `"@@xpack-dev-tools/xbb-helper":`. ### Commit the changes to `build-assets/package.json` -Commit with the message _**build-assets/package.json: bump deps**_. +Commit with the message _**template: build-assets/package-merge-liquid.json: bump deps**_. ### Check for disk space @@ -554,11 +552,11 @@ rm -rf ~/Work/xpack-dev-tools/*/build-assets/build ### Generate the GitHub workflows -Run the **generate-workflows** xpm/xPack action to update the +Run the top **generate-top-commons** npm script to update the GitHub workflow files. ```sh -xpm run generate-workflows -C ~/Work/xpack-dev-tools/cmake-xpack.git/build-assets +npm run generate-workflows -C ~/Work/xpack-dev-tools/cmake-xpack.git ``` ### Commit and push @@ -605,7 +603,7 @@ These commands use the `xpack-development` branch of this repo. The workflow results and logs are available from the [GitHub Actions](https://github.com/xpack-dev-tools/cmake-xpack/actions) page. -Update the values in `website/docs/maintainer/_github-actions-durations.mdx` +Update the values in `website/docs/_shared/_github-actions-durations.mdx` with those shown by GitHub Actions. Commit with the message _**website: update actions durations**_. @@ -748,8 +746,8 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/cmake-xpack.git/bui ### Update the web install page - check and possibly update the output of the `--version` runs in - - `website/docs/install/_automatic-install-quick-test.mdx` - - `website/docs/install/_manual-install-quick-test.mdx` + - `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**_ ### Check the list of links in top package.json diff --git a/website/package.json b/website/package.json index 19d003a..15f2cab 100644 --- a/website/package.json +++ b/website/package.json @@ -21,9 +21,9 @@ "npm-link-helpers": "npm link @xpack/docusaurus-template-liquid @xpack/npm-packages-helper", "npm-ci": "npm ci", "deep-clean": "del-cli .docusaurus build node_modules package-lock.json", - "import-website-releases": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/website-import-releases.sh", - "generate-website-blog-post": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-blog-post.sh", - "generate-dependencies-details": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-dependencies-details.sh" + "import-website-releases": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/import-releases.sh --xpack-dev-tools", + "generate-website-blog-post": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-blog-post.sh --xpack-dev-tools", + "generate-dependencies-details": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-dependencies-details.sh --xpack-dev-tools" }, "dependencies": { "@docusaurus/core": "3.6.3", diff --git a/website/src/css/custom.css b/website/src/css/custom.css index e43c43e..7b98f33 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -72,6 +72,16 @@ h2[class*="title"] .markdown h1:first-child { --ifm-h1-font-size: 2.5em } +img.mac-stadium-img { + float: right; + width: 200px; +} + +code { + vertical-align: baseline; +} + +/* ------------------------------------------------------------------------- */ .header-home-link::before { content: ''; @@ -135,6 +145,8 @@ h2[class*="title"] background: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; } +/* ------------------------------------------------------------------------- */ + .getting-started-link::before { content: ''; width: 1.5em; @@ -175,7 +187,7 @@ h2[class*="title"] background: url("/img/bulb-on-svgrepo-com-dark.svg") no-repeat; } -/* --- */ +/* ------------------------------------------------------------------------- */ .header-github-link:hover { opacity: 0.6; @@ -195,6 +207,7 @@ h2[class*="title"] no-repeat; } +/* ------------------------------------------------------------------------- */ .platform-windows::before { content: ''; @@ -321,13 +334,4 @@ h2[class*="title"] margin-left: 0.6em; } -img.mac-stadium-img { - float: right; - width: 200px; -} - -code { - vertical-align: baseline; -} - /* ------------------------------------------------------------------------- */