@@ -384,15 +384,16 @@ caffeinate ssh xbbla
384384caffeinate ssh xbbla32
385385```
386386
387- Start the runner inside a ` screen ` session:
387+ Create a ` screen ` session, to provide a persistent standard output for
388+ the runners:
388389
389390``` sh
390391screen -S ga
391392```
392393
393394To quit it, use ` # Ctrl-a Ctrl-d ` .
394395
395- For ` xbbli ` & ` xbbla ` start two runners:
396+ For ` xbbli ` & ` xbbla ` , which have more memory, start two runners:
396397
397398``` sh
398399~ /actions-runners/xpack-dev-tools/1/run.sh &
@@ -419,10 +420,7 @@ killall Runner.Listener
419420
420421### Check the status of the runners
421422
422- The status of all self-hosted runners is available at:
423-
424- - https://github.com/organizations/xpack-dev-tools/settings/actions/runners
425-
423+ The status of all self-hosted runners is available at the [ GitHub Runners] ( https://github.com/organizations/xpack-dev-tools/settings/actions/runners ) page.
426424
427425### Publish the helper
428426
@@ -474,25 +472,15 @@ GitHub workflow files.
474472
475473To trigger the GitHub Actions builds, use the xPack actions:
476474
477- - ` trigger-workflow-build-darwin-x64 `
478- - ` trigger-workflow-build-darwin-arm64 `
479- - ` trigger-workflow-build-linux-x64 `
480- - ` trigger-workflow-build-win32-x64 `
481- - ` trigger-workflow-build-linux-arm64 `
482- - ` trigger-workflow-build-linux-arm `
483-
484- These are equivalent to:
485-
486- ``` sh
487- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-darwin-x64.yml
488- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-darwin-arm64.yml
489- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-linux-x64.yml
490- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-win32-x64.yml
491- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-linux-arm64.yml
492- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-build.sh --workflow build-linux-arm.yml
493- ```
475+ - ** ` trigger-workflow-build-darwin-x64 ` **
476+ - ** ` trigger-workflow-build-darwin-arm64 ` **
477+ - ** ` trigger-workflow-build-linux-x64 ` **
478+ - ** ` trigger-workflow-build-win32-x64 ` **
479+ - ** ` trigger-workflow-build-linux-arm64 ` **
480+ - ** ` trigger-workflow-build-linux-arm ` **
494481
495- These scripts require the ` GITHUB_API_DISPATCH_TOKEN ` variable to be present
482+ The scripts behind these actions require the ` GITHUB_API_DISPATCH_TOKEN `
483+ variable to be present
496484in the environment, and the organization ` PUBLISH_TOKEN ` to be visible in the
497485Settings → Action →
498486[ Secrets] ( https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/settings/secrets/actions )
@@ -512,25 +500,17 @@ The resulting binaries are available for testing from
512500
513501## Run the tests
514502
515- ### CI tests
503+ ### Automated tests
516504
517505The automation is provided by GitHub Actions.
518506
519507To trigger the GitHub Actions tests, use the xPack actions:
520508
521- - ` trigger-workflow-test-prime `
522- - ` trigger-workflow-test-docker-linux-intel `
523- - ` trigger-workflow-test-docker-linux-arm `
524-
525- These are equivalent to:
526-
527- ``` sh
528- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-prime.sh
529- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-docker-linux-intel.sh
530- bash ~ /Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/build-assets/xpacks/@xpack-dev-tools/xbb-helper/github-actions/trigger-workflow-test-docker-linux-arm.sh
531- ```
509+ - ** ` trigger-workflow-test-prime ` **
510+ - ** ` trigger-workflow-test-docker-linux-intel ` **
511+ - ** ` trigger-workflow-test-docker-linux-arm ` **
532512
533- These scripts require the ` GITHUB_API_DISPATCH_TOKEN ` variable to be present
513+ The scripts behind these accesible require the ` GITHUB_API_DISPATCH_TOKEN ` variable to be present
534514in the environment.
535515
536516These actions use the ` xpack-development ` branch of this repo and the
@@ -540,12 +520,12 @@ binaries.
540520The tests results are available from the
541521[ GitHub Actions] ( https://github.com/xpack-dev-tools/openocd-xpack/actions/ ) page.
542522
543- Since GitHub Actions provides a single version of a macOS runner, the
544- multi-version macOS tests run on Travis.
523+ Since GitHub Actions provides a limited range of versions for the macOS
524+ runner, the multi-version macOS tests run on Travis.
545525
546526To trigger the Travis test, use the xPack action:
547527
548- - ` trigger-travis-macos `
528+ - ** ` trigger-travis-macos ` **
549529
550530This is equivalent to:
551531
@@ -591,7 +571,7 @@ xattr -cr ${HOME}/Downloads/xpack-*
591571 like _ ** \* v{ customField (' upstreamVersion' ) } -{ customField (' xpackSubversion' ) } released** _
592572- commit with _ ** CHANGELOG update** _
593573- check and possibly update the ` build-assets/templates/body-github-release-liquid.mdx `
594- - push the ` xpack-development ` branch
574+ - push the ` xpack-development ` branch to GitHub
595575- run the xPack action
596576 - ** ` trigger-workflow-publish-release ` **
597577
@@ -664,7 +644,7 @@ watching this project.
664644- <code ><b >npm version { customField (' upstreamVersion' ) } -{ customField (' xpackSubversion' ) } .{ customField (' npmSubversion' ) } </b ></code >; the first 4 numbers are the same as the
665645 GitHub release; the fifth number is the npm specific version
666646- the commits and the tag should have been pushed by the ` postversion ` script;
667- if not, push them with ` git push origin --tags `
647+ if not, push them with ` git push origin --tags ` to GitHub
668648- ** ` npm publish --tag next ` ** (use ` npm publish --access public `
669649 when publishing for the first time; add the ` next ` tag)
670650
@@ -698,7 +678,7 @@ In case the previous version is not functional and needs to be unpublished:
698678### Update the repo & publish the website
699679
700680- merge ` xpack-development ` into ` xpack `
701- - push to GitHub
681+ - push the ` xpack ` branch to GitHub
702682
703683At this moment the website is also generated.
704684
0 commit comments