{"id":18635771,"url":"https://github.com/xpack-dev-tools/docus-mock-xpack","last_synced_at":"2025-11-04T12:30:36.779Z","repository":{"id":189397866,"uuid":"612089397","full_name":"xpack-dev-tools/docus-mock-xpack","owner":"xpack-dev-tools","description":"A mock project for experimenting with Docusaurus","archived":false,"fork":false,"pushed_at":"2024-08-06T04:21:09.000Z","size":1070,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"xpack","last_synced_at":"2024-12-27T08:44:11.886Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://xpack-dev-tools.github.io/docus-mock-xpack/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xpack-dev-tools.png","metadata":{"files":{"readme":"README-MAINTAINER.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"ilegeul","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2023-03-10T07:11:08.000Z","updated_at":"2024-07-23T05:10:44.000Z","dependencies_parsed_at":"2024-12-27T11:45:37.064Z","dependency_job_id":null,"html_url":"https://github.com/xpack-dev-tools/docus-mock-xpack","commit_stats":null,"previous_names":["xpack-dev-tools/docus-mock-xpack"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpack-dev-tools%2Fdocus-mock-xpack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpack-dev-tools%2Fdocus-mock-xpack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpack-dev-tools%2Fdocus-mock-xpack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpack-dev-tools%2Fdocus-mock-xpack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xpack-dev-tools","download_url":"https://codeload.github.com/xpack-dev-tools/docus-mock-xpack/tar.gz/refs/heads/xpack","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239433912,"owners_count":19637806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T05:26:33.086Z","updated_at":"2025-11-04T12:30:36.747Z","avatar_url":"https://github.com/xpack-dev-tools.png","language":"Shell","funding_links":["https://ko-fi.com/ilegeul"],"categories":[],"sub_categories":[],"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)\n[![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/)\n[![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)\n\n# Maintainer info\n\n## Get project sources\n\nThe project is hosted on GitHub:\n\n- \u003chttps://github.com/xpack-dev-tools/docus-mock-xpack.git\u003e\n\nTo clone the stable branch (`xpack`), run the following commands in a\nterminal (on Windows use the _Git Bash_ console):\n\n```sh\nrm -rf ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\ngit clone https://github.com/xpack-dev-tools/docus-mock-xpack.git \\\n  ~/Work/xpacks/docus-mock-xpack.git\n```\n\nFor development purposes, clone the `xpack-develop` branch:\n\n```sh\nrm -rf ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nmkdir -p ~/Work/xpacks \u0026\u0026 \\\ngit clone \\\n  --branch xpack-develop \\\n  https://github.com/xpack-dev-tools/docus-mock-xpack.git \\\n  ~/Work/xpacks/docus-mock-xpack.git\n```\n\n## Get helper sources\n\nThe project has a dependency to a common **helper**; clone the\n`xpack-develop` branch and link it to the central xPacks store:\n\n```sh\nrm -rf ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nmkdir -p ~/Work/xpacks \u0026\u0026 \\\ngit clone \\\n  --branch xpack-develop \\\n  https://github.com/xpack-dev-tools/xbb-helper-xpack.git \\\n  ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git\n```\n\nOr, if the repo was already cloned:\n\n```sh\ngit -C ~/Work/xpacks/xbb-helper-xpack.git pull\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git\n```\n\n## Prerequisites\n\nA recent [xpm](https://xpack.github.io/xpm/), which is a portable\n[Node.js](https://nodejs.org/) command line application.\n\n## Release schedule\n\nThe xPack Docus Mock release schedule generally follows the original GitHub\n[releases](https://github.com/docus-mock/ninja/releases/), but with a\nfew weeks filter, which means that releases that are overridden in\na few weeks may be skipped.\n\n## How to make new releases\n\nBefore starting the build, perform some checks and tweaks.\n\n### Download the build scripts\n\nThe build scripts are available in the `scripts` folder of the\n[`xpack-dev-tools/docus-mock-xpack`](https://github.com/xpack-dev-tools/docus-mock-xpack)\nGit repo.\n\nTo download them on a new machine, clone the `xpack-develop` branch,\nas seen above.\n\n### Check Git\n\nIn the `xpack-dev-tools/docus-mock-xpack` Git repo:\n\n- switch to the `xpack-develop` branch\n- pull new changes\n- if needed, merge the `xpack` branch\n\nNo need to add a tag here, it'll be added when the release is created.\n\n### Check the latest upstream release\n\nCheck the Docus Mock GitHub [Releases](https://github.com/docus-mock/ninja/releases/)\nand compare the the xPack [Releases](https://github.com/xpack-dev-tools/docus-mock-xpack/releases/).\n\n### Increase the version\n\nDetermine the version (like `1.11.1`) and update the `scripts/VERSION`\nfile; the format is `1.11.1-2`. The fourth number is the xPack release number\nof this version. A fifth number will be added when publishing\nthe package on the `npm` server.\n\n### Fix possible open issues\n\nCheck GitHub issues and pull requests:\n\n- \u003chttps://github.com/xpack-dev-tools/docus-mock-xpack/issues/\u003e\n\nand fix them; assign them to a milestone (like `1.11.1-2`).\n\n### Check `README.md`\n\nNormally `README.md` should not need changes, but better check.\nInformation related to the new version should not be included here,\nbut in the version specific release page.\n\n### Update versions in `README` files\n\n- update version in `README-MAINTAINER.md`\n- update version in `README.md`\n\n### Update `CHANGELOG.md`\n\n- open the `CHANGELOG.md` file\n- check if all previous fixed issues are in\n- add a new entry like _* v1.11.1-2 prepared_\n- commit with a message like _prepare v1.11.1-2_\n\n### Merge upstream repo\n\nTo keep the development repository in sync with the original Ninja\nrepository, in the `xpack-dev-tools/ninja` Git fork repo:\n\n- fetch `upstream`\n- checkout `release`\n- merge from `upstream/release`\n- checkout `xpack-develop`\n- merge `release`\n- checkout `xpack`\n- merge `xpack-develop`\n- tag it with `v1.11.1-2-xpack`; important, this tag will be used by the build\n- push `release`, `xpack-develop`, `xpack` to `origin`\n\n### Update the version specific code\n\n- open the `scripts/versioning.sh` file\n- add a new `if` with the new version before the existing code\n\n## Build\n\nThe builds currently run on 5 dedicated machines (Intel GNU/Linux,\nArm 32 GNU/Linux, Arm 64 GNU/Linux, Intel macOS and Apple Silicon macOS).\n\n### Development run the build scripts\n\nBefore the real build, run test builds on all platforms.\n\n#### Visual Studio Code\n\nAll actions are defined as **xPack actions** and can be conveniently\ntriggered via the VS Code graphical interface, using the\n[xPack extension](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack).\n\n#### Intel macOS\n\nFor Intel macOS, first run the build on the development machine\n(`wksi`, a recent macOS):\n\n```sh\n# Update the build scripts.\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull\n\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git\n\n# For backup overhead reasons, on the development machine\n# the builds happen on a separate Work folder.\nrm -rf ~/Work/docus-mock-[0-9]*-*\n\nxpm install --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run build-develop --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nWhen functional, push the `xpack-develop` branch to GitHub.\n\nRun the native build on the production machine\n(`xbbmi`, an older macOS);\nstart a VS Code remote session, or connect with a terminal:\n\n```sh\ncaffeinate ssh xbbmi\n```\n\n```sh\n# Update the build scripts (or clone them the first time).\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull\n\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git\n\nxpm run deep-clean --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git\n\nxpm install --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run build-develop --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nThe build takes about 30 minutes.\n\nWhen functional, push the `xpack-develop` branch to GitHub.\n\nRun the native build on the production machine\n(`xbbmi`, an older macOS);\nstart a VS Code remote session, or connect with a terminal:\n\n```sh\ncaffeinate ssh xbbmi\n```\n\nRepeat the same steps as before.\n\n```sh\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull \u0026\u0026 \\\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\ngit -C ~/Work/xpacks/xbb-helper-xpack.git pull \u0026\u0026 \\\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nxpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run deep-clean --config darwin-x64  -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm install --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run build-develop --config darwin-x64 -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nSeveral minutes later, the output of the build script is a compressed\narchive and its SHA signature, created in the `deploy` folder:\n\n```console\n$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/darwin-x64/deploy\ntotal 312\n-rw-r--r--  1 ilg  staff  153317 Jan 23 23:11 xpack-docus-mock-1.11.1-2-darwin-x64.tar.gz\n-rw-r--r--  1 ilg  staff     111 Jan 23 23:11 xpack-docus-mock-1.11.1-2-darwin-x64.tar.gz.sha\n```\n\n#### Apple Silicon macOS\n\nRun the native build on the production machine\n(`xbbma`, an older macOS);\nstart a VS Code remote session, or connect with a terminal:\n\n```sh\ncaffeinate ssh xbbma\n```\n\nUpdate the build scripts (or clone them at the first use):\n\n```sh\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull \u0026\u0026 \\\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\ngit -C ~/Work/xpacks/xbb-helper-xpack.git pull \u0026\u0026 \\\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nxpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run deep-clean --config darwin-arm64  -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm install --config darwin-arm64 -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run build-develop --config darwin-arm64 -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nSeveral minutes later, the output of the build script is a compressed\narchive and its SHA signature, created in the `deploy` folder:\n\n```console\n$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/darwin-arm64/deploy\ntotal 304\n-rw-r--r--  1 ilg  staff  147640 Jan 23 23:11 xpack-docus-mock-1.11.1-2-darwin-arm64.tar.gz\n-rw-r--r--  1 ilg  staff     113 Jan 23 23:11 xpack-docus-mock-1.11.1-2-darwin-arm64.tar.gz.sha\n```\n\n#### Intel GNU/Linux\n\nRun the docker build on the production machine (`xbbli`);\nstart a VS Code remote session, or connect with a terminal:\n\n```sh\ncaffeinate ssh xbbli\n```\n\n##### Build the GNU/Linux binaries\n\nUpdate the build scripts (or clone them at the first use):\n\n```sh\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull \u0026\u0026 \\\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\ngit -C ~/Work/xpacks/xbb-helper-xpack.git pull \u0026\u0026 \\\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nxpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run deep-clean --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-prepare --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-link-deps --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run docker-build-develop --config linux-x64 -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nSeveral minutes later, the output of the build script is a compressed\narchive and its SHA signature, created in the `deploy` folder:\n\n```console\n$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/linux-x64/deploy\ntotal 364\n-rw-r--r-- 1 ilg ilg 367167 Jan 23 21:12 xpack-docus-mock-1.11.1-2-linux-x64.tar.gz\n-rw-r--r-- 1 ilg ilg    110 Jan 23 21:12 xpack-docus-mock-1.11.1-2-linux-x64.tar.gz.sha\n```\n\n##### Build the Windows binaries\n\nClean the build folder and prepare the docker container:\n\n```sh\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull \u0026\u0026 \\\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\ngit -C ~/Work/xpacks/xbb-helper-xpack.git pull \u0026\u0026 \\\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nxpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run deep-clean --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-prepare --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-link-deps --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run docker-build-develop --config win32-x64 -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nSeveral minutes later, the output of the build script is a compressed\narchive and its SHA signature, created in the `deploy` folder:\n\n```console\n$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/win32-x64/deploy\ntotal 520\n-rw-r--r-- 1 ilg ilg 527262 Jan 23 21:14 xpack-docus-mock-1.11.1-2-win32-x64.zip\n-rw-r--r-- 1 ilg ilg    107 Jan 23 21:14 xpack-docus-mock-1.11.1-2-win32-x64.zip.sha\n```\n\n#### Arm GNU/Linux 64-bit\n\nRun the docker build on the production machine (`xbbla64`);\nstart a VS Code remote session, or connect with a terminal:\n\n```sh\ncaffeinate ssh xbbla64\n```\n\nUpdate the build scripts (or clone them at the first use):\n\n```sh\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull \u0026\u0026 \\\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\ngit -C ~/Work/xpacks/xbb-helper-xpack.git pull \u0026\u0026 \\\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nxpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run deep-clean --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-prepare --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-link-deps --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run docker-build-develop --config linux-arm64 -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nSeveral minutes later, the output of the build script is a compressed\narchive and its SHA signature, created in the `deploy` folder:\n\n```console\n$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/linux-arm64/deploy\ntotal 344\n-rw-r--r-- 1 ilg ilg 347709 Jan 23 21:15 xpack-docus-mock-1.11.1-2-linux-arm64.tar.gz\n-rw-r--r-- 1 ilg ilg    112 Jan 23 21:15 xpack-docus-mock-1.11.1-2-linux-arm64.tar.gz.sha\n```\n\n#### Arm GNU/Linux 32-bit\n\nRun the docker build on the production machine (`xbbla32`);\nstart a VS Code remote session, or connect with a terminal:\n\n```sh\ncaffeinate ssh xbbla32\n```\n\nUpdate the build scripts (or clone them at the first use):\n\n```sh\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull \u0026\u0026 \\\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\ngit -C ~/Work/xpacks/xbb-helper-xpack.git pull \u0026\u0026 \\\nxpm link -C ~/Work/xpacks/xbb-helper-xpack.git \u0026\u0026 \\\nxpm run link-deps -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run deep-clean --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-prepare --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git \u0026\u0026 \\\nxpm run docker-link-deps --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run docker-build-develop --config linux-arm -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nSeveral minutes later, the output of the build script is a compressed\narchive and its SHA signature, created in the `deploy` folder:\n\n```console\n$ ls -l ~/Work/xpacks/docus-mock-xpack.git/build/linux-arm/deploy\ntotal 316\n-rw-r--r-- 1 ilg ilg 317951 Jan 23 21:16 xpack-docus-mock-1.11.1-2-linux-arm.tar.gz\n-rw-r--r-- 1 ilg ilg    110 Jan 23 21:16 xpack-docus-mock-1.11.1-2-linux-arm.tar.gz.sha\n```\n\n### Files cache\n\nThe XBB build scripts use a local cache such that files are downloaded only\nduring the first run, later runs being able to use the cached files.\n\nHowever, occasionally some servers may not be available, and the builds\nmay fail.\n\nThe workaround is to manually download the files from an alternate\nlocation (like\n\u003chttps://github.com/xpack-dev-tools/files-cache/tree/master/libs\u003e),\nplace them in the XBB cache (`Work/cache`) and restart the build.\n\n## Run the CI build\n\nThe automation is provided by GitHub Actions and three self-hosted runners.\n\n### Generate the GitHub workflows\n\nRun the `generate-workflows` to re-generate the\nGitHub workflow files; commit and push if necessary.\n\n### Start the self-hosted runners\n\n- on the development machine (`wksi`) open ssh sessions to the build\nmachines (`xbbma`, `xbbli`, `xbbla64` and `xbbla32`):\n\n```sh\ncaffeinate ssh xbbma\ncaffeinate ssh xbbli\ncaffeinate ssh xbbla64\ncaffeinate ssh xbbla32\n```\n\nStart the runners on all machines:\n\n```sh\nscreen -S ga\n\n~/actions-runners/xpack-dev-tools/run.sh \u0026\n\n# Ctrl-a Ctrl-d\n```\n\nFor `xbbli` \u0026 `xbbla64` start two runners:\n\n```sh\n~/actions-runners/xpack-dev-tools/1/run.sh \u0026\n~/actions-runners/xpack-dev-tools/2/run.sh \u0026\n```\n\n### Push the build scripts\n\n- push the `xpack-develop` branch to GitHub\n- possibly push the helper project too\n\nFrom here it'll be cloned on the production machines.\n\n### Check for disk space\n\nCheck if the build machines have enough free space and eventually\ndo some cleanups.\n\n### Manually trigger the build GitHub Actions\n\nTo trigger the GitHub Actions build, use the xPack action:\n\n- `trigger-workflow-build-xbbli`\n- `trigger-workflow-build-xbbla64`\n- `trigger-workflow-build-xbbla32`\n- `trigger-workflow-build-xbbmi`\n- `trigger-workflow-build-xbbma`\n\nThis is equivalent to:\n\n```sh\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbli\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbla64\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbla32\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbmi\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-build.sh --machine xbbma\n```\n\nThese scripts require the `GITHUB_API_DISPATCH_TOKEN` variable to be present\nin the environment, and the organization `PUBLISH_TOKEN` to be visible in the\nSettings → Action →\n[Secrets](https://github.com/xpack-dev-tools/docus-mock-xpack/settings/secrets/actions)\npage.\n\nThese commands use the `xpack-develop` branch of this repo.\n\n## Durations \u0026 results\n\nThe builds take a few minutes to complete.\n\nThe workflow result and logs are available from the\n[Actions](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.\n\nThe resulting binaries are available for testing from\n[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/).\n\n## Testing\n\n### CI tests\n\nThe automation is provided by GitHub Actions.\n\nTo trigger the GitHub Actions tests, use the xPack actions:\n\n- `trigger-workflow-test-prime`\n- `trigger-workflow-test-docker-linux-intel`\n- `trigger-workflow-test-docker-linux-arm`\n\nThese are equivalent to:\n\n```sh\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-test-prime.sh\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-test-docker-linux-intel.sh\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-workflow-test-docker-linux-arm.sh\n```\n\nThese scripts require the `GITHUB_API_DISPATCH_TOKEN` variable to be present\nin the environment.\n\nThese actions use the `xpack-develop` branch of this repo and the\n[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/)\nbinaries.\n\nThe tests results are available from the\n[Actions](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.\n\nSince GitHub Actions provides a single version of macOS, the\nmulti-version macOS tests run on Travis.\n\nTo trigger the Travis test, use the xPack action:\n\n- `trigger-travis-macos`\n\nThis is equivalent to:\n\n```sh\nbash ~/Work/xpacks/docus-mock-xpack.git/xpacks/xpack-dev-tools-xbb-helper/github-actions/trigger-travis-macos.sh\n```\n\nThis script requires the `TRAVIS_COM_TOKEN` variable to be present\nin the environment.\n\nThe test results are available from\n[Travis CI](https://app.travis-ci.com/github/xpack-dev-tools/docus-mock-xpack/builds/).\n\n### Manual tests\n\nTo download the pre-released archive for the specific platform\nand run the tests, use:\n\n```sh\ngit -C ~/Work/xpacks/docus-mock-xpack.git pull\nxpm run install -C ~/Work/xpacks/docus-mock-xpack.git\nxpm run test-pre-release -C ~/Work/xpacks/docus-mock-xpack.git\n```\n\nFor even more tests, on each platform (MacOS, GNU/Linux, Windows),\ndownload the archive from\n[pre-releases/test](https://github.com/xpack-dev-tools/pre-releases/releases/tag/test/)\nand check the binaries.\n\nOn macOS, remove the `com.apple.quarantine` flag:\n\n```sh\nxattr -dr com.apple.quarantine ${HOME}/Downloads/xpack-*\n```\n\nOn GNU/Linux and macOS systems, use:\n\n```sh\n.../xpack-docus-mock-1.11.1-2/bin/ninja --version\n1.11.1\n```\n\nOn Windows use:\n\n```dos\n...\\xpack-docus-mock-1.11.1-2\\bin\\ninja --version\n1.11.1\n```\n\n## Create a new GitHub pre-release draft\n\n- in `CHANGELOG.md`, add the release date and a message like _* v1.11.1-2 released_\n- commit with _CHANGELOG update_\n- check and possibly update the `templates/body-github-release-liquid.md`\n- push the `xpack-develop` branch\n- run the xPack action `trigger-workflow-publish-release`\n\nThe workflow result and logs are available from the\n[Actions](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.\n\nThe result is a\n[draft pre-release](https://github.com/xpack-dev-tools/docus-mock-xpack/releases/)\ntagged like **v1.11.1-2** (mind the dash in the middle!) and\nnamed like **xPack Docus Mock v1.11.1-2** (mind the dash),\nwith all binaries attached.\n\n- edit the draft and attach it to the `xpack-develop` branch (important!)\n- save the draft (do **not** publish yet!)\n\n## Prepare a new blog post\n\n- check and possibly update the `templates/body-jekyll-release-*-liquid.md`\n  (for the release dates use \u003chttps://github.com/docus-mock/ninja/releases/\u003e)\n- run the xPack action `generate-jekyll-post`; this will leave a file\non the Desktop.\n\nIn the `xpack/web-jekyll` GitHub repo:\n\n- select the `develop` branch\n- copy the new file to `_posts/releases/docus-mock`\n- update version and date from last\n[release](https://github.com/docus-mock/ninja/releases/).\n\nIf any, refer to closed\n[issues](https://github.com/xpack-dev-tools/docus-mock-xpack/issues/).\n\n## Update the preview Web\n\n- commit the `develop` branch of `xpack/web-jekyll` GitHub repo;\n  use a message like _xPack Docus Mock v1.11.1-2 released_\n- push to GitHub\n- wait for the GitHub Pages build to complete\n- the preview web is \u003chttps://xpack.github.io/web-preview/news/\u003e\n\n## Create the pre-release\n\n- go to the GitHub [Releases](https://github.com/xpack-dev-tools/docus-mock-xpack/releases/) page\n- perform the final edits and check if everything is fine\n- temporarily fill in the _Continue Reading »_ with the URL of the\n  web-preview release\n- **keep the pre-release button enabled**\n- do not enable Discussions yet\n- publish the release\n\nNote: at this moment the system should send a notification to all clients\nwatching this project.\n\n## Update the READMEs listings and examples\n\n- check and possibly update the `ls -l` output\n- check and possibly update the output of the `--version` runs\n- check and possibly update the output of `tree -L 2` in the README file\n- commit changes\n\n## Check the list of links\n\n- open the `package.json` file\n- check if the links in the `bin` property cover the actual binaries\n- if necessary, also check on Windows\n\n## Update package.json binaries\n\n- select the `xpack-develop` branch\n- run the xPack action `update-package-binaries`\n- open the `package.json` file\n- check the `baseUrl:` it should match the file URLs (including the tag/version);\n  no terminating `/` is required\n- from the release, check the SHA \u0026 file names\n- compare the SHA sums with those shown by `cat *.sha`\n- check the executable names\n- commit all changes, use a message like\n  _package.json: update urls for 1.11.1-2.1 release_ (without _v_)\n\n## Publish on the npmjs.com server\n\n- select the `xpack-develop` branch\n- check the latest commits `npm run git-log`\n- update `CHANGELOG.md`, add a line like _* v1.11.1-2.1 published on npmjs.com_\n- commit with a message like _CHANGELOG: publish npm v1.11.1-2.1_\n- `npm pack` and check the content of the archive, which should list\n  only the `package.json`, the `README.md`, `LICENSE` and `CHANGELOG.md`;\n  possibly adjust `.npmignore`\n- `npm version 1.11.1-2.1`; the first 4 numbers are the same as the\n  GitHub release; the fifth number is the npm specific version\n- the commits and the tag should have been pushed by the `postversion` script;\n  if not, push them with `git push origin --tags`\n- `npm publish --tag next` (use `npm publish --access public`\n  when publishing for the first time; add the `next` tag)\n\nAfter a few moments the version will be visible at:\n\n- \u003chttps://www.npmjs.com/package/@xpack-dev-tools/docus-mock?activeTab=versions\u003e\n\n## Test if the binaries can be installed with xpm\n\nRun the xPack action `trigger-workflow-test-xpm`, this\nwill install the package via `xpm install` on all supported platforms.\n\nThe tests results are available from the\n[Actions](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.\n\n## Update the repo\n\n- merge `xpack-develop` into `xpack`\n- push to GitHub\n\n## Tag the npm package as `latest`\n\nWhen the release is considered stable, promote it as `latest`:\n\n- `npm dist-tag ls @xpack-dev-tools/docus-mock`\n- `npm dist-tag add @xpack-dev-tools/docus-mock@1.11.1-2.1 latest`\n- `npm dist-tag ls @xpack-dev-tools/docus-mock`\n\nIn case the previous version is not functional and needs to be unpublished:\n\n- `npm unpublish @xpack-dev-tools/docus-mock@1.11.1-2.1`\n\n## Update the Web\n\n- in the `master` branch, merge the `develop` branch\n- wait for the GitHub Pages build to complete\n- the result is in \u003chttps://xpack.github.io/news/\u003e\n- remember the post URL, since it must be updated in the release page\n\n## Create the final GitHub release\n\n- go to the GitHub [Releases](https://github.com/xpack-dev-tools/docus-mock-xpack/releases/) page\n- check the download counter, it should match the number of tests\n- add a link to the Web page `[Continue reading »]()`; use an same blog URL\n- remove the _tests only_ notice\n- **disable** the **pre-release** button\n- click the **Update Release** button\n\n## Share on Twitter\n\n- in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)\n- using the `@xpack_project` account\n- paste the release name like **xPack Docus Mock v1.11.1-2 released**\n- paste the link to the Web page\n  [release](https://xpack.github.io/docus-mock/releases/)\n- click the **Tweet** button\n\n## Remove the pre-release binaries\n\n- go to \u003chttps://github.com/xpack-dev-tools/pre-releases/releases/tag/test/\u003e\n- remove the test binaries\n\n## Clean the work area\n\nRun the xPack action `trigger-workflow-deep-clean`, this\nwill remove the build folders on all supported platforms.\n\nThe results are available from the\n[Actions](https://github.com/xpack-dev-tools/docus-mock-xpack/actions/) page.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxpack-dev-tools%2Fdocus-mock-xpack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxpack-dev-tools%2Fdocus-mock-xpack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxpack-dev-tools%2Fdocus-mock-xpack/lists"}