diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 000000000..b8896a950 --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,34 @@ +# rust-bitcoin workflow notes + +We are attempting to run max 20 parallel jobs using GitHub actions (usage limit for free tier). + +ref: https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration + +The minimal/recent lock files are handled by CI (`rust.yml`). + +## Jobs + +Run from `rust.yml` unless stated otherwise. Total 21 jobs but +`Prepare` is quick and must be run first anyway. + +0. `Prepare` +1. `Stable - minimal` +2. `Stable - recent` +3. `Nightly - minimal` +4. `Nightly - recent` +5. `MSRV - minimal` +6. `MSRV - recent` +7. `Lint` +8. `Docs` +9. `Docsrs` +10. `Bench` +11. `ASAN` +12. `WASM` +13. `schemars` +14. `Arch32bit` +15. `Cross` +16. `Embedded` +17. `Kani` +18. `Coveralls` - run by `coveralls.yml` +19. `release` - run by `release.yml` +20. `labeler` - run by `manage-pr.yml` diff --git a/contrib/run_task.sh b/contrib/run_task.sh index 1c7c54d1c..ff647eec6 100755 --- a/contrib/run_task.sh +++ b/contrib/run_task.sh @@ -1,41 +1,4 @@ #!/usr/bin/env bash -# -# We are attempting to run max 20 parallel jobs using GitHub actions (usage limit for free tier). -# -# ref: https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration -# -# The minimal/recent manifests are handled by CI (rust.yaml). -# -# Jobs (shell functions) that get run twice, once for each manifest: -# -# 1+2 stable -# 3+4 nightly -# 5+6 msrv -# -# Jobs (shell functions) that get run once: -# -# 7 lint -# 8 docs -# 9 docsrs -# 10 bench -# 11 asan -# 12 wasm -# 13 schemars -# -# Jobs run directly by rust.yml workflow: -# -# 0 Prepare -# -# 14 Arch32bit -# 15 Cross -# 16 Embedded -# 17 Kani -# -# Jobs run directly from other workflows: -# -# 18 Coveralls - run by coveralls.yml -# 19 release - run by release.yml -# 20 labeler - run by manage-pr.yml set -euox pipefail