Maintainer info

Prerequisites

The build scripts run on GNU/Linux and macOS. The Windows binaries are generated on Intel GNU/Linux, using mingw-w64.

For details on installing the prerequisites, please read the XBB prerequisites page.

Get project sources

The project is hosted on GitHub:

https://github.com/xpack-dev-tools/cmake-xpack.git

To clone the stable branch (xpack), run the following commands in a terminal (on Windows use the Git Bash console):

rm -rf ~/Work/xpack-dev-tools/cmake-xpack.git && \
git clone https://github.com/xpack-dev-tools/cmake-xpack.git \
  ~/Work/xpack-dev-tools/cmake-xpack.git

For development purposes, clone the xpack-develop branch:

rm -rf ~/Work/xpack-dev-tools/cmake-xpack.git && \
mkdir -p ~/Work/xpack-dev-tools && \
git clone \
  --branch xpack-develop \
  https://github.com/xpack-dev-tools/cmake-xpack.git \
  ~/Work/xpack-dev-tools/cmake-xpack.git

Or, if the repo was already cloned:

git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull

Get helper sources

The project has a dependency to a common helper; clone the xpack-develop branch and link it to the central xPacks store:

rm -rf ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
mkdir -p ~/Work/xpack-dev-tools && \
git clone \
  --branch xpack-develop \
  https://github.com/xpack-dev-tools/xbb-helper-xpack.git \
  ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git

Or, if the repo was already cloned:

git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git

Release schedule

This distribution is generally one minor release behind the upstream releases, trying to capture the latest patch of a previous minor version (the 3.x.3 rule of thumb rule, see below).

How to make new releases

Before starting the build, perform some checks and tweaks.

Download the build scripts

The build scripts are available in the scripts folder of the xpack-dev-tools/cmake-xpack Git repo.

To download them on a new machine, clone the xpack-develop branch, as seen above.

Check Git

In the xpack-dev-tools/cmake-xpack Git repo:

switch to the xpack-develop branch
pull new changes
if needed, merge the xpack branch

No need to add a tag here, it'll be added when the release is created.

Update helper & other dependencies

Check the latest versions at https://github.com/xpack-dev-tools/ and update the dependencies in package.json.

Check the latest upstream release

Check the CMake GitHub Releases and compare the the xPack Releases. Find the latest release and go 1-2 minor releases back; the purpose is to find the one which looks old enough to be the one which will not be further updated (this is tricky, and failing will require an extra release; a possible rule of thumb would be to wait for 3.x.3, before releasing 3.x-1.y).

Increase the version

Determine the version (like 3.28.6) and update the scripts/VERSION file; the format is 3.28.6-1. The fourth number is the xPack release number of this version. A fifth number will be added when publishing the package on the npm server.

Fix possible open issues

Check GitHub issues and pull requests:

https://github.com/xpack-dev-tools/cmake-xpack/issues/

and fix them; assign them to a milestone (like 3.28.6-1).

Check `README.md`

Normally README.md should not need changes, but better check. Information related to the new version should not be included here, but in the version specific release page.

Update versions in `README` files

update version in README-MAINTAINER.md
update version in README.md

Update version in `package.json` to a pre-release

Use the new version, suffixed by pre, like 3.28.6-1.pre.

Update `CHANGELOG.md`

open the CHANGELOG.md file
check if all previous fixed issues are in
add a new entry like * v3.28.6-1 prepared
commit with a message like prepare v3.28.6-1

Merge upstream repo

To keep the development repository fork in sync with the upstream CMake repository, in the xpack-dev-tools/cmake Git repo:

checkout the v3.28.6 tag
create a branch like v3.28.6-xpack
merge into master
checkout new branch
cherry pick the commit to add cmd.exe support from a previous release; enable commit immediately
push branch to origin
add a v3.28.6-1-xpack tag; enable push to origin
save as patch
move to patches
rename cmake-3.28.6.git.patch

Note: the branch name and the tag name are used during tests, to pull the repo.

Update the version specific code

open the scripts/versioning.sh file
add a new if with the new version before the existing code

Build

The builds currently run on 5 dedicated machines (Intel GNU/Linux, Arm 32 GNU/Linux, Arm 64 GNU/Linux, Intel macOS and Apple Silicon macOS).

Development run the build scripts

Before the real build, run test builds on all platforms.

Visual Studio Code

All actions are defined as xPack actions and can be conveniently triggered via the VS Code graphical interface, using the xPack extension.

Intel macOS

For Intel macOS, first run the build on the development machine (wksi, a recent macOS):

export XBB_ENVIRONMENT_SKIP_CHECKS="y"

# Update the build scripts.
rm -f ~/Work/xpack-dev-tools/cmake-xpack.git/package-lock.json
git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull

xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git

git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git

xpm run link-deps -C ~/Work/xpack-dev-tools/cmake-xpack.git

xpm run deep-clean --config darwin-x64  -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm install --config darwin-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run build-development --config darwin-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git

For a debug build:

xpm run build-development-debug --config darwin-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git

The build takes several minutes to complete.

When functional, push the xpack-develop branch to GitHub.

Run the native build on the production machine (xbbmi, an older macOS); start a VS Code remote session, or connect with a terminal:

caffeinate ssh xbbmi

Repeat the same steps as before.

rm -f ~/Work/xpack-dev-tools/cmake-xpack.git/package-lock.json && \
git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull && \
xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
\
xpm run deep-clean --config darwin-x64  -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm install --config darwin-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run build-development --config darwin-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git

About 10 minutes later, the output of the build script is a compressed archive and its SHA signature, created in the deploy folder:

$ ls -l ~/Work/xpack-dev-tools/cmake-xpack.git/build/darwin-x64/deploy
total 47128
-rw-r--r--  1 ilg  staff  23467402 Apr  2 00:03 xpack-cmake-3.28.6-1-darwin-x64.tar.gz
-rw-r--r--  1 ilg  staff       105 Apr  2 00:03 xpack-cmake-3.28.6-1-darwin-x64.tar.gz.sha

Apple Silicon macOS

Run the native build on the production machine (xbbma, an older macOS); start a VS Code remote session, or connect with a terminal:

caffeinate ssh xbbma

Update the build scripts (or clone them at the first use):

rm -f ~/Work/xpack-dev-tools/cmake-xpack.git/package-lock.json && \
git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull && \
xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
\
xpm run deep-clean --config darwin-arm64  -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm install --config darwin-arm64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run build-development --config darwin-arm64 -C ~/Work/xpack-dev-tools/cmake-xpack.git

About 5 minutes later, the output of the build script is a compressed archive and its SHA signature, created in the deploy folder:

$ ls -l ~/Work/xpack-dev-tools/cmake-xpack.git/build/darwin-arm64/deploy
total 42568
-rw-r--r--  1 ilg  staff  21631155 Apr  1 23:59 xpack-cmake-3.28.6-1-darwin-arm64.tar.gz
-rw-r--r--  1 ilg  staff       107 Apr  1 23:59 xpack-cmake-3.28.6-1-darwin-arm64.tar.gz.sha

Intel GNU/Linux

Run the docker build on the production machine (xbbli); start a VS Code remote session, or connect with a terminal:

caffeinate ssh xbbli

Build the Intel GNU/Linux binaries

Update the build scripts (or clone them at the first use):

rm -f ~/Work/xpack-dev-tools/cmake-xpack.git/package-lock.json && \
git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull && \
xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
\
xpm run deep-clean --config linux-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-prepare --config linux-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-link-deps --config linux-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-build-development --config linux-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git

About 8 minutes later, the output of the build script is a compressed archive and its SHA signature, created in the deploy folder:

$ ls -l ~/Work/xpack-dev-tools/cmake-xpack.git/build/linux-x64/deploy
total 28140
-rw-r--r-- 1 ilg ilg 28809779 Apr  1 21:02 xpack-cmake-3.28.6-1-linux-x64.tar.gz
-rw-r--r-- 1 ilg ilg      104 Apr  1 21:02 xpack-cmake-3.28.6-1-linux-x64.tar.gz.sha

Build the Intel Windows binaries

Clean the build folder and prepare the docker container:

rm -f ~/Work/xpack-dev-tools/cmake-xpack.git/package-lock.json && \
git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull && \
xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
\
xpm run deep-clean --config win32-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-prepare --config win32-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-link-deps --config win32-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-build-development --config win32-x64 -C ~/Work/xpack-dev-tools/cmake-xpack.git

About 6 minutes later, the output of the build script is a compressed archive and its SHA signature, created in the deploy folder:

$ ls -l ~/Work/xpack-dev-tools/cmake-xpack.git/build/win32-x64/deploy
total 24336
-rw-r--r-- 1 ilg ilg 24913762 Apr  1 21:04 xpack-cmake-3.28.6-1-win32-x64.zip
-rw-r--r-- 1 ilg ilg      101 Apr  1 21:04 xpack-cmake-3.28.6-1-win32-x64.zip.sha

Arm GNU/Linux 64-bit

Run the docker build on the production machine (xbbla); start a VS Code remote session, or connect with a terminal:

caffeinate ssh xbbla

Update the build scripts (or clone them at the first use):

rm -f ~/Work/xpack-dev-tools/cmake-xpack.git/package-lock.json && \
git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull && \
xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
\
xpm run deep-clean --config linux-arm64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-prepare --config linux-arm64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-link-deps --config linux-arm64 -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-build-development --config linux-arm64 -C ~/Work/xpack-dev-tools/cmake-xpack.git

About 46 minutes later (15 minutes on ampere), the output of the build script is a compressed archive and its SHA signature, created in the deploy folder:

$ ls -l ~/Work/xpack-dev-tools/cmake-xpack.git/build/linux-arm64/deploy
total 25928
-rw-r--r-- 1 ilg ilg 26542177 Apr  1 21:56 xpack-cmake-3.28.6-1-linux-arm64.tar.gz
-rw-r--r-- 1 ilg ilg      106 Apr  1 21:56 xpack-cmake-3.28.6-1-linux-arm64.tar.gz.sha

Arm GNU/Linux 32-bit

Run the docker build on the production machine (xbbla32); start a VS Code remote session, or connect with a terminal:

caffeinate ssh xbbla32

Update the build scripts (or clone them at the first use):

rm -f ~/Work/xpack-dev-tools/cmake-xpack.git/package-lock.json && \
git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull && \
xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
\
xpm run deep-clean --config linux-arm -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-prepare --config linux-arm -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-link-deps --config linux-arm -C ~/Work/xpack-dev-tools/cmake-xpack.git && \
xpm run docker-build-development --config linux-arm -C ~/Work/xpack-dev-tools/cmake-xpack.git

About 40 minutes later, the output of the build script is a compressed archive and its SHA signature, created in the deploy folder:

$ ls -l ~/Work/xpack-dev-tools/cmake-xpack.git/build/linux-arm/deploy
total 24180
-rw-r--r-- 1 ilg ilg 24753465 Apr  1 21:50 xpack-cmake-3.28.6-1-linux-arm.tar.gz
-rw-r--r-- 1 ilg ilg      104 Apr  1 21:50 xpack-cmake-3.28.6-1-linux-arm.tar.gz.sha

Update README-MAINTAINER listing output

check and possibly update the ls -l output in README-MAINTAINER

Update the list of links in package.json

Copy/paste the full list of links displayed at the end of the build, in sequence, for each platform (GNU/Linux, macOS, Windows), and check the differences compared to the repository.

Commit if necessary.

How to build a debug version

In some cases it is necessary to run a debug session in the binaries, or even in the libraries functions.

For these cases, the build script accepts the --debug options.

There are also xPack actions that use this option (build-development-debug and docker-build-development-debug).

Files cache

The XBB build scripts use a local cache such that files are downloaded only during the first run, later runs being able to use the cached files.

However, occasionally some servers may not be available, and the builds may fail.

The workaround is to manually download the files from an alternate location (like https://github.com/xpack-dev-tools/files-cache/tree/master/libs), place them in the XBB cache (Work/cache) and restart the build.

Run the CI build

The automation is provided by GitHub Actions and three self-hosted runners.

Generate the GitHub workflows

Run the generate-workflows to re-generate the GitHub workflow files; commit and push if necessary.

Start the self-hosted runners

on the development machine (wksi) open ssh sessions to the build machines (xbbmi, xbbma, xbbli, xbbla and xbbla32):

caffeinate ssh xbbmi
caffeinate ssh xbbma
caffeinate ssh xbbli
caffeinate ssh xbbla
caffeinate ssh xbbla32

For xbbli & xbbla start two runners:

screen -S ga

~/actions-runners/xpack-dev-tools/1/run.sh &
~/actions-runners/xpack-dev-tools/2/run.sh &

# Ctrl-a Ctrl-d

On all other machines start a single runner:

screen -S ga

~/actions-runners/xpack-dev-tools/run.sh &

# Ctrl-a Ctrl-d

Check if the runners are active:

https://github.com/organizations/xpack-dev-tools/settings/actions/runners

Push the build scripts

push the xpack-develop branch to GitHub
possibly push the helper project too

From here it'll be cloned on the production machines.

Publish helper

Publish a new release of the helper and update the reference in package.json.

Check for disk space

Check if the build machines have enough free space and eventually do some cleanups (df -BG -H / on Linux, df -gH / on macOS).

To remove previous builds, use:

rm -rf ~/Work/xpack-dev-tools/*/build

Manually trigger the build GitHub Actions

To trigger the GitHub Actions builds, use the xPack actions:

trigger-workflow-build-darwin-x64
trigger-workflow-build-darwin-arm64
trigger-workflow-build-linux-x64
trigger-workflow-build-win32-x64
trigger-workflow-build-linux-arm64
trigger-workflow-build-linux-arm

These are equivalent to:

bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-darwin-x64.yml
bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-darwin-arm64.yml
bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-linux-x64.yml
bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-win32-x64.yml
bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-linux-arm64.yml
bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-linux-arm.yml

These scripts 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 → Secrets page.

These commands use the xpack-develop branch of this repo.

Durations & results

The builds take about 36 minutes to complete:

xbbmi: 12 min (nuc)
xbbma: 6 min
xbbli: 10 min Linux, 10 min Windows
xbbla: 47 min
xbbla32: 41 min

The workflow result and logs are available from the Actions page.

The resulting binaries are available for testing from pre-releases/test.

Testing

CI tests

The automation is provided by GitHub Actions.

To trigger the GitHub Actions tests, use the xPack actions:

trigger-workflow-test-prime
trigger-workflow-test-docker-linux-intel
trigger-workflow-test-docker-linux-arm

These are equivalent to:

bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-prime.sh
bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-docker-linux-x64.sh
bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-docker-linux-arm.sh

These scripts 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 → Secrets page.

These actions use the xpack-develop branch of this repo and the pre-releases/test binaries.

The tests results are available from the Actions page.

Since GitHub Actions provides a single version of macOS, the multi-version macOS tests run on Travis.

To trigger the Travis test, use the xPack action:

trigger-travis-macos

This is equivalent to:

bash ~/Work/xpack-dev-tools/cmake-xpack.git/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-travis-macos.sh

This script requires the TRAVIS_COM_TOKEN variable to be present in the environment.

The test results are available from Travis CI.

Manual tests

To download the pre-released archive for the specific platform and run the tests, use:

git -C ~/Work/xpack-dev-tools/cmake-xpack.git pull
xpm run install -C ~/Work/xpack-dev-tools/cmake-xpack.git
xpm run test-pre-release -C ~/Work/xpack-dev-tools/cmake-xpack.git

For even more tests, on each platform (MacOS, GNU/Linux, Windows), download the archive from pre-releases/test and check the binaries.

On macOS, remove the com.apple.quarantine flag:

xattr -cr ${HOME}/Downloads/xpack-*

On GNU/Linux and macOS systems, use:

.../xpack-cmake-3.28.6-1/bin/cmake --version
cmake version 3.28.6

CMake suite maintained and supported by Kitware (kitware.com/cmake).

On Windows use:

...\xpack-cmake-3.28.6-1\bin\cmake --version
cmake version 3.28.6

CMake suite maintained and supported by Kitware (kitware.com/cmake).

Create a new GitHub pre-release draft

in CHANGELOG.md, add the release date and a message like * v3.28.6-1 released
commit with CHANGELOG update
check and possibly update the templates/body-github-release-liquid.md
push the xpack-develop branch
run the xPack action trigger-workflow-publish-release

The workflow result and logs are available from the Actions page.

The result is a draft pre-release tagged like v3.28.6-1 (mind the dash in the middle!) and named like xPack CMake v3.28.6-1 (mind the dash), with all binaries attached.

edit the draft and attach it to the xpack-develop branch (important!)
save the draft (do not publish yet!)

Prepare a new blog post

check and possibly update the templates/body-jekyll-release-*-liquid.md (for release dates use https://github.com/Kitware/CMake/releases/)
run the xPack action generate-jekyll-post; this will leave a file on the Desktop.

In the xpack/web-jekyll GitHub repo:

select the develop branch
copy the new file to _posts/releases/cmake

If any, refer to closed issues.

Update the preview Web

commit the develop branch of xpack/web-jekyll GitHub repo; use a message like xPack CMake v3.28.6-1 released
push to GitHub
wait for the GitHub Pages build to complete
the preview web is https://xpack.github.io/web-preview/news/

Create the pre-release

go to the GitHub Releases page
perform the final edits and check if everything is fine
temporarily fill in the Continue Reading » with the URL of the web-preview release
keep the pre-release button enabled
do not enable Discussions yet
publish the release

Note: at this moment the system should send a notification to all clients watching this project.

Update the READMEs listings and examples

check and possibly update the output of tree -L 2 in README
check and possibly update the output of the --version runs in README-MAINTAINER
commit changes

Check the list of links in package.json

open the package.json file
check if the links in the bin property cover the actual binaries
if necessary, also check on Windows

Update package.json binaries

select the xpack-develop branch
run the xPack action update-package-binaries
open the 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, use a message like package.json: update urls for 3.28.6-1.2 release (without v)

Publish on the npmjs.com server

select the xpack-develop branch
check the latest commits npm run git-log
update CHANGELOG.md, add a line like * v3.28.6-1.2 published on npmjs.com
commit with a message like CHANGELOG: publish npm v3.28.6-1.2
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
npm version 3.28.6-1.2; the first 5 numbers are the same as the GitHub release; the sixth number is the npm specific version
the commits and the tag should have been pushed by the postversion script; if not, push them with git push origin --tags
npm publish --tag next (use npm publish --access public when publishing for the first time; add the next tag)

After a few moments the version will be visible at:

https://www.npmjs.com/package/@xpack-dev-tools/cmake?activeTab=versions

Test if the binaries can be installed with xpm

Run the xPack action trigger-workflow-test-xpm, this will install the package via xpm install on all supported platforms.

The tests results are available from the Actions page.

Update the repo

merge xpack-develop into xpack
push to GitHub

Tag the npm package as `latest`

When the release is considered stable, promote it as latest:

npm dist-tag ls @xpack-dev-tools/cmake
npm dist-tag add @xpack-dev-tools/cmake@3.28.6-1.2 latest
npm dist-tag ls @xpack-dev-tools/cmake

In case the previous version is not functional and needs to be unpublished:

npm unpublish @xpack-dev-tools/cmake@3.28.6-1.2

Update the Web

in the master branch, merge the develop branch
wait for the GitHub Pages build to complete
the result is in https://xpack.github.io/news/
remember the post URL, since it must be updated in the release page

Create the final GitHub release

go to the GitHub Releases page
check the download counter, it should match the number of tests
add a link to the Web page [Continue reading »](); use an same blog URL
remove the tests only notice
disable the pre-release button
click the Update Release button

Share on Twitter

in a separate browser windows, open X/Twitter
using the @xpack_project account
paste the release name like xPack CMake v3.28.6-1 released
paste the link to the Web page release
click the Tweet button

Check SourceForge mirror

https://sourceforge.net/projects/cmake-xpack/files/

Remove the pre-release binaries

go to https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/
remove the test binaries

Clean the work area

Run the xPack action trigger-workflow-deep-clean, this will remove the build folders on all supported platforms.

The results are available from the Actions page.

Files

README-MAINTAINER.md

Latest commit

History

README-MAINTAINER.md

File metadata and controls

Maintainer info

Prerequisites

Get project sources

Get helper sources

Release schedule

How to make new releases

Download the build scripts

Check Git

Update helper & other dependencies

Check the latest upstream release

Increase the version

Fix possible open issues

Check README.md

Update versions in README files

Update version in package.json to a pre-release

Update CHANGELOG.md

Merge upstream repo

Update the version specific code

Build

Development run the build scripts

Visual Studio Code

Intel macOS

Apple Silicon macOS

Intel GNU/Linux

Build the Intel GNU/Linux binaries

Build the Intel Windows binaries

Arm GNU/Linux 64-bit

Arm GNU/Linux 32-bit

Update README-MAINTAINER listing output

Update the list of links in package.json

How to build a debug version

Files cache

Run the CI build

Generate the GitHub workflows

Start the self-hosted runners

Push the build scripts

Publish helper

Check for disk space

Manually trigger the build GitHub Actions

Durations & results

Testing

CI tests

Manual tests

Create a new GitHub pre-release draft

Prepare a new blog post

Update the preview Web

Create the pre-release

Update the READMEs listings and examples

Check the list of links in package.json

Update package.json binaries

Publish on the npmjs.com server

Test if the binaries can be installed with xpm

Update the repo

Tag the npm package as latest

Update the Web

Create the final GitHub release

Share on Twitter

Check SourceForge mirror

Remove the pre-release binaries

Clean the work area

Check `README.md`

Update versions in `README` files

Update version in `package.json` to a pre-release

Update `CHANGELOG.md`

Tag the npm package as `latest`