Skip to content

Commit f878e84

Browse files
committed
Document package registration workflow [skip ci]
1 parent 6476e2b commit f878e84

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@
7171
- PRs target `master`, stay scoped, and include what changed, why, and what was tested.
7272
- Add trigger labels at PR creation when the first CI run matters: `documentation`, `run-gpu-ci`, or `pre-release`. Adding them after PR creation is too late for the first run.
7373
- Release tags are annotated tags on current `origin/master`, not feature branches: `git fetch origin master --tags`, `git tag -a <tag> -F notes.md origin/master`, `git push origin <tag>`, `gh release create <tag> --title <tag> --notes-file notes.md`.
74+
- Register package versions only after the release PR is merged and `origin/master` contains the target package/version. Do not trigger JuliaRegistrator from an open PR.
75+
- For subpackage registration, comment on the merged `origin/master` commit, not the PR: `@JuliaRegistrator register subdir=<PackageName>`. PR comments do not trigger Registrator in this repo.
76+
- Registration comes before tagging/releasing: wait for the corresponding `JuliaRegistries/General` PR to merge, then create the annotated package tag and GitHub release from the same `origin/master` commit.
7477
- Registrator notes must mention breaking status: include `## Breaking changes` or state `No breaking changes`.
7578

7679
## References

0 commit comments

Comments
 (0)