Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xpack-dev-tools/docus-mock-xpack

A mock project for experimenting with Docusaurus
https://github.com/xpack-dev-tools/docus-mock-xpack

Last synced: 15 days ago
JSON representation

A mock project for experimenting with Docusaurus

Host: GitHub
URL: https://github.com/xpack-dev-tools/docus-mock-xpack
Owner: xpack-dev-tools
License: mit
Created: 2023-03-10T07:11:08.000Z (almost 2 years ago)
Default Branch: xpack
Last Pushed: 2024-08-06T04:21:09.000Z (5 months ago)
Last Synced: 2024-11-07T05:33:56.897Z (2 months ago)
Language: Shell
Homepage: https://xpack-dev-tools.github.io/docus-mock-xpack/
Size: 1.02 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README-MAINTAINER.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

[![license](https://img.shields.io/github/license/xpack-dev-tools/docus-mock-xpack)](https://github.com/xpack-dev-tools/docus-mock-xpack/blob/xpack/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/docus-mock-xpack.svg)](https://github.com/xpack-dev-tools/docus-mock-xpack/issues/)
[![GitHub pulls](https://img.shields.io/github/issues-pr/xpack-dev-tools/docus-mock-xpack.svg)](https://github.com/xpack-dev-tools/docus-mock-xpack/pulls)

# Maintainer info

## Get project sources

The project is hosted on GitHub:

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

```sh
rm -rf ~/Work/xpacks/docus-mock-xpack.git && \
git clone https://github.com/xpack-dev-tools/docus-mock-xpack.git \
~/Work/xpacks/docus-mock-xpack.git
```

For development purposes, clone the `xpack-develop` branch:

```sh
rm -rf ~/Work/xpacks/docus-mock-xpack.git && \
mkdir -p ~/Work/xpacks && \
git clone \
--branch xpack-develop \
https://github.com/xpack-dev-tools/docus-mock-xpack.git \
~/Work/xpacks/docus-mock-xpack.git
```

## 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:

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

Or, if the repo was already cloned:

```sh
git -C ~/Work/xpacks/xbb-helper-xpack.git pull
xpm link -C ~/Work/xpacks/xbb-helper-xpack.git
```

## Prerequisites

A recent [xpm](https://xpack.github.io/xpm/), which is a portable
[Node.js](https://nodejs.org/) command line application.

## Release schedule

The xPack Docus Mock release schedule generally follows the original GitHub
[releases](https://github.com/docus-mock/ninja/releases/), but with a
few weeks filter, which means that releases that are overridden in
a few weeks may be skipped.

## 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/docus-mock-xpack`](https://github.com/xpack-dev-tools/docus-mock-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/docus-mock-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.

### Check the latest upstream release

Check the Docus Mock GitHub [Releases](https://github.com/docus-mock/ninja/releases/)
and compare the the xPack [Releases](https://github.com/xpack-dev-tools/docus-mock-xpack/releases/).

### Increase the version

Determine the version (like `1.11.1`) and update the `scripts/VERSION`
file; the format is `1.11.1-2`. 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:

and fix them; assign them to a milestone (like `1.11.1-2`).

### 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 `CHANGELOG.md`

- open the `CHANGELOG.md` file
- check if all previous fixed issues are in
- add a new entry like _* v1.11.1-2 prepared_
- commit with a message like _prepare v1.11.1-2_

### Merge upstream repo

To keep the development repository in sync with the original Ninja
repository, in the `xpack-dev-tools/ninja` Git fork repo:

- fetch `upstream`
- checkout `release`
- merge from `upstream/release`
- checkout `xpack-develop`
- merge `release`
- checkout `xpack`
- merge `xpack-develop`
- tag it with `v1.11.1-2-xpack`; important, this tag will be used by the build
- push `release`, `xpack-develop`, `xpack` to `origin`

### 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](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack).

#### Intel macOS

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

```sh
# Update the build scripts.
git -C ~/Work/xpacks/docus-mock-xpack.git pull

xpm run install -C ~/Work/xpacks/docus-mock-xpack.git

# For backup overhead reasons, on the development machine
# the builds happen on a separate Work folder.
rm -rf ~/Work/docus-mock-[0-9]*-*

xpm install --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git
xpm run build-develop --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git
```

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:

```sh
caffeinate ssh xbbmi
```

```sh
# Update the build scripts (or clone them the first time).
git -C ~/Work/xpacks/docus-mock-xpack.git pull

xpm run install -C ~/Work/xpacks/docus-mock-xpack.git

xpm run deep-clean --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git

xpm install --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git
xpm run build-develop --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git
```

The build takes about 30 minutes.

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:

```sh
caffeinate ssh xbbmi
```

Repeat the same steps as before.

```sh
git -C ~/Work/xpacks/docus-mock-xpack.git pull && \
xpm run install -C ~/Work/xpacks/docus-mock-xpack.git && \
git -C ~/Work/xpacks/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpacks/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run deep-clean --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm install --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git
xpm run build-develop --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git
```

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

```console
$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/darwin-x64/deploy
total 312
-rw-r--r-- 1 ilg staff 153317 Jan 23 23:11 xpack-docus-mock-1.11.1-2-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 111 Jan 23 23:11 xpack-docus-mock-1.11.1-2-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:

```sh
caffeinate ssh xbbma
```

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

```sh
git -C ~/Work/xpacks/docus-mock-xpack.git pull && \
xpm run install -C ~/Work/xpacks/docus-mock-xpack.git && \
git -C ~/Work/xpacks/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpacks/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run deep-clean --config darwin-arm64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm install --config darwin-arm64 -C ~/Work/xpacks/docus-mock-xpack.git
xpm run build-develop --config darwin-arm64 -C ~/Work/xpacks/docus-mock-xpack.git
```

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

```console
$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/darwin-arm64/deploy
total 304
-rw-r--r-- 1 ilg staff 147640 Jan 23 23:11 xpack-docus-mock-1.11.1-2-darwin-arm64.tar.gz
-rw-r--r-- 1 ilg staff 113 Jan 23 23:11 xpack-docus-mock-1.11.1-2-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:

```sh
caffeinate ssh xbbli
```

##### Build the GNU/Linux binaries

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

```sh
git -C ~/Work/xpacks/docus-mock-xpack.git pull && \
xpm run install -C ~/Work/xpacks/docus-mock-xpack.git && \
git -C ~/Work/xpacks/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpacks/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run deep-clean --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-prepare --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-link-deps --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git
xpm run docker-build-develop --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git
```

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

```console
$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/linux-x64/deploy
total 364
-rw-r--r-- 1 ilg ilg 367167 Jan 23 21:12 xpack-docus-mock-1.11.1-2-linux-x64.tar.gz
-rw-r--r-- 1 ilg ilg 110 Jan 23 21:12 xpack-docus-mock-1.11.1-2-linux-x64.tar.gz.sha
```

##### Build the Windows binaries

Clean the build folder and prepare the docker container:

```sh
git -C ~/Work/xpacks/docus-mock-xpack.git pull && \
xpm run install -C ~/Work/xpacks/docus-mock-xpack.git && \
git -C ~/Work/xpacks/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpacks/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run deep-clean --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-prepare --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-link-deps --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git
xpm run docker-build-develop --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git
```

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

```console
$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/win32-x64/deploy
total 520
-rw-r--r-- 1 ilg ilg 527262 Jan 23 21:14 xpack-docus-mock-1.11.1-2-win32-x64.zip
-rw-r--r-- 1 ilg ilg 107 Jan 23 21:14 xpack-docus-mock-1.11.1-2-win32-x64.zip.sha
```

#### Arm GNU/Linux 64-bit

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

```sh
caffeinate ssh xbbla64
```

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

```sh
git -C ~/Work/xpacks/docus-mock-xpack.git pull && \
xpm run install -C ~/Work/xpacks/docus-mock-xpack.git && \
git -C ~/Work/xpacks/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpacks/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run deep-clean --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-prepare --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-link-deps --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git
xpm run docker-build-develop --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git
```

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

```console
$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/linux-arm64/deploy
total 344
-rw-r--r-- 1 ilg ilg 347709 Jan 23 21:15 xpack-docus-mock-1.11.1-2-linux-arm64.tar.gz
-rw-r--r-- 1 ilg ilg 112 Jan 23 21:15 xpack-docus-mock-1.11.1-2-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:

```sh
caffeinate ssh xbbla32
```

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

```sh
git -C ~/Work/xpacks/docus-mock-xpack.git pull && \
xpm run install -C ~/Work/xpacks/docus-mock-xpack.git && \
git -C ~/Work/xpacks/xbb-helper-xpack.git pull && \
xpm link -C ~/Work/xpacks/xbb-helper-xpack.git && \
xpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run deep-clean --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-prepare --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git && \
xpm run docker-link-deps --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git
xpm run docker-build-develop --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git
```

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

```console
$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/linux-arm/deploy
total 316
-rw-r--r-- 1 ilg ilg 317951 Jan 23 21:16 xpack-docus-mock-1.11.1-2-linux-arm.tar.gz
-rw-r--r-- 1 ilg ilg 110 Jan 23 21:16 xpack-docus-mock-1.11.1-2-linux-arm.tar.gz.sha
```

### 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
),
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 (`xbbma`, `xbbli`, `xbbla64` and `xbbla32`):

```sh
caffeinate ssh xbbma
caffeinate ssh xbbli
caffeinate ssh xbbla64
caffeinate ssh xbbla32
```

Start the runners on all machines:

```sh
screen -S ga

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

# Ctrl-a Ctrl-d
```

For `xbbli` & `xbbla64` start two runners:

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

### 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.

### Check for disk space

Check if the build machines have enough free space and eventually
do some cleanups.

### Manually trigger the build GitHub Actions

To trigger the GitHub Actions build, use the xPack action:

- `trigger-workflow-build-xbbli`
- `trigger-workflow-build-xbbla64`
- `trigger-workflow-build-xbbla32`
- `trigger-workflow-build-xbbmi`
- `trigger-workflow-build-xbbma`

This is equivalent to:

```sh
bash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbli
bash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbla64
bash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbla32
bash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbmi
bash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbma
```

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](https://github.com/xpack-dev-tools/docus-mock-xpack/settings/secrets/actions)
page.

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

## Durations & results

The builds take a few minutes to complete.

The workflow result and logs are available from the
[Actions](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.

The resulting binaries are available for testing from
[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/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:

```sh
bash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-test-prime.sh
bash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-test-docker-linux-intel.sh
bash ~/Work/xpacks/docus-mock-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.

These actions use the `xpack-develop` branch of this repo and the
[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/)
binaries.

The tests results are available from the
[Actions](https://github.com/xpack-dev-tools/docus-mock-xpack/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:

```sh
bash ~/Work/xpacks/docus-mock-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](https://app.travis-ci.com/github/xpack-dev-tools/docus-mock-xpack/builds/).

### Manual tests

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

```sh
git -C ~/Work/xpacks/docus-mock-xpack.git pull
xpm run install -C ~/Work/xpacks/docus-mock-xpack.git
xpm run test-pre-release -C ~/Work/xpacks/docus-mock-xpack.git
```

For even more tests, on each platform (MacOS, GNU/Linux, Windows),
download the archive from
[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/)
and check the binaries.

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

```sh
xattr -dr com.apple.quarantine ${HOME}/Downloads/xpack-*
```

On GNU/Linux and macOS systems, use:

```sh
.../xpack-docus-mock-1.11.1-2/bin/ninja --version
1.11.1
```

On Windows use:

```dos
...\xpack-docus-mock-1.11.1-2\bin\ninja --version
1.11.1
```

## Create a new GitHub pre-release draft

- in `CHANGELOG.md`, add the release date and a message like _* v1.11.1-2 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](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.

The result is a
[draft pre-release](https://github.com/xpack-dev-tools/docus-mock-xpack/releases/)
tagged like **v1.11.1-2** (mind the dash in the middle!) and
named like **xPack Docus Mock v1.11.1-2** (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 the release dates use )
- 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/docus-mock`
- update version and date from last
[release](https://github.com/docus-mock/ninja/releases/).

If any, refer to closed
[issues](https://github.com/xpack-dev-tools/docus-mock-xpack/issues/).

## Update the preview Web

- commit the `develop` branch of `xpack/web-jekyll` GitHub repo;
use a message like _xPack Docus Mock v1.11.1-2 released_
- push to GitHub
- wait for the GitHub Pages build to complete
- the preview web is

## Create the pre-release

- go to the GitHub [Releases](https://github.com/xpack-dev-tools/docus-mock-xpack/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 `ls -l` output
- check and possibly update the output of the `--version` runs
- check and possibly update the output of `tree -L 2` in the README file
- commit changes

## Check the list of links

- 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 1.11.1-2.1 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 _* v1.11.1-2.1 published on npmjs.com_
- commit with a message like _CHANGELOG: publish npm v1.11.1-2.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`
- `npm version 1.11.1-2.1`; the first 4 numbers are the same as the
GitHub release; the fifth 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:

## 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](https://github.com/xpack-dev-tools/docus-mock-xpack/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/docus-mock`
- `npm dist-tag add @xpack-dev-tools/[email protected] latest`
- `npm dist-tag ls @xpack-dev-tools/docus-mock`

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

- `npm unpublish @xpack-dev-tools/[email protected]`

## Update the Web

- in the `master` branch, merge the `develop` branch
- wait for the GitHub Pages build to complete
- the result is in
- remember the post URL, since it must be updated in the release page

## Create the final GitHub release

- go to the GitHub [Releases](https://github.com/xpack-dev-tools/docus-mock-xpack/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 [TweetDeck](https://tweetdeck.twitter.com/)
- using the `@xpack_project` account
- paste the release name like **xPack Docus Mock v1.11.1-2 released**
- paste the link to the Web page
[release](https://xpack.github.io/docus-mock/releases/)
- click the **Tweet** button

## Remove the pre-release binaries

- go to
- 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](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.