Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update developers.md #205

Merged
merged 2 commits into from
Feb 15, 2024
Merged

Update developers.md #205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de864e1
Update developers.md
miguelbiron Feb 14, 2024
7dc2346
repease without PR
miguelbiron Feb 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/src/developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Creating a release
# Creating a release from a PR

The github actions for `Registrator` and
`TagBot` are active, so the instructions are
(see https://juliareach.github.io/JuliaReachDevDocs/latest/release/ for details)
1. Create a new branch locally.
2. Make changes, and **make sure all tests pass locally**.
3. When done, push the branch to the repo and create a PR. **Make sure all tests pass on CI**.
4. Your PR will be reviewed by the team.
5. After the review, but **before merging**, make sure to **bump the version in `Project.toml`**. Follow [this convention](https://juliareach.github.io/JuliaReachDevDocs/latest/release/#Choosing-a-new-release-version).
6. Merge the PR (and possibly delete the branch where you did your work).
7. Navigate to the **merge commit** (**hint**: this should be on the **main** branch!) and make the comment `@JuliaRegistrator register`. [See here for an example](https://github.com/Julia-Tempering/Pigeons.jl/commit/9d7e6e942a7f9194f8e10c46599e871da633f5b1).
8. If all goes well, the bots will take it from here. After the Julia registry merges our release PR, TagBot will create a tag for the release automatically.

- Make sure you are in a separate branch than main
- Increment the package version in `Project.toml` following the convention in https://juliareach.github.io/JuliaReachDevDocs/latest/release/#Choosing-a-new-release-version
- Commit and **make sure all tests pass on CI and locally**
- Comment `@JuliaRegistrator register` on the commit/branch you want to register.

# Creating a release without a PR

Do step 7 above with the latest commit on main ([example](https://github.com/Julia-Tempering/Pigeons.jl/commit/f363507f08e60df582750b198b9f49cbd8f5d34a)).

# Running tests

Expand Down
Loading