EcoSpecies-Atlas/docs/forgejo-activation.md

39 lines
1.7 KiB
Markdown

# Forgejo CI Activation Checklist
Use this checklist before turning on a Forgejo-native pipeline for `EcoSpecies-Atlas`.
## 1. Confirm Workflow Source
- Decide whether the repository will continue using the fallback `.github/workflows/ci.yml` definition or activate a dedicated `.forgejo/workflows/ci.yml`.
- If a Forgejo-native workflow is desired, start from `.forgejo/workflows/ci.yml.template`.
## 2. Confirm Runner Labels
- Identify the runner label accepted by the target Forgejo instance.
- Replace the placeholder `runs-on: docker` values in the template with that label before activation.
- Verify that the selected runner can execute both Python and Node-based jobs.
## 3. Confirm Action Source Policy
- Check whether the Forgejo instance allows GitHub-hosted actions such as `actions/checkout`, `actions/setup-python`, and `actions/setup-node`.
- If remote GitHub-hosted actions are not allowed, replace those `uses:` entries with approved internal or mirrored actions.
## 4. Activate The Workflow
1. Copy `.forgejo/workflows/ci.yml.template` to `.forgejo/workflows/ci.yml`.
2. Update runner labels.
3. Update action references if required by the instance policy.
4. Commit the activated workflow.
## 5. Validate CI Behavior
- Open a test change request and confirm the repository-layer API tests run.
- Confirm the stubbed browser smoke test runs and passes.
- Verify that failures block merges according to the repository-host policy.
## 6. Optional Hardening
- Require the `CI` workflow before merge.
- Mirror or pin all action sources used by the Forgejo workflow.
- Document any instance-specific runner labels or action mirrors in the repository host settings or administrator notes.