Skip to content

BLD: use release branches#954

Merged
mj-will merged 4 commits into
bilby-dev:mainfrom
mj-will:use-release-branches
Sep 4, 2025
Merged

BLD: use release branches#954
mj-will merged 4 commits into
bilby-dev:mainfrom
mj-will:use-release-branches

Conversation

@mj-will

@mj-will mj-will commented May 2, 2025

Copy link
Copy Markdown
Collaborator

Change how we make releases to use release branches.

This should make it easier to backport bug fixes to versions being used in production analyses.

Note: this requires #952

@ColmTalbot ColmTalbot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with this change, and the docs generally look good. I just had a question about the GUI vs CLI approaches.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md

If making a major or minor release you must first make the release branch from the current `main` branch

```bash

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I usually do these things through the GUI (making the release branch/tags/releases), is there a reason the command line version is being recommended instead?

The only thing to note is that the new tag should be made from the release branch and not from main.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to it via the command line so I can verify I've tagged the correct commit but I agree both methods work.

I've updated the instructions to mention both methods.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just basic.

@ColmTalbot ColmTalbot added to discuss To be discussed on an upcoming call and removed to discuss To be discussed on an upcoming call labels May 12, 2025
@mj-will mj-will added this to the 2.7.0 milestone Aug 27, 2025
@mj-will mj-will force-pushed the use-release-branches branch from b3ec9f3 to dfd2630 Compare September 2, 2025 15:36
@mj-will mj-will force-pushed the use-release-branches branch from dfd2630 to 11b5f43 Compare September 2, 2025 15:42
mj-will and others added 2 commits September 2, 2025 16:51
Co-authored-by: Colm Talbot <talbotcolm@gmail.com>
@mj-will mj-will marked this pull request as ready for review September 2, 2025 16:14
Comment thread CONTRIBUTING.md

If making a major or minor release you must first make the release branch from the current `main` branch

```bash

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just basic.

@GregoryAshton GregoryAshton left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

@mj-will mj-will added this pull request to the merge queue Sep 4, 2025
Merged via the queue into bilby-dev:main with commit 16508fc Sep 4, 2025
12 checks passed
@mj-will mj-will deleted the use-release-branches branch September 4, 2025 16:22
mj-will added a commit to mj-will/bilby that referenced this pull request Oct 16, 2025
* BLD: use release branch semver

* DOC: update `making releases` to describe process using release branches

* DOC: fix typo

Co-authored-by: Colm Talbot <talbotcolm@gmail.com>

* DOC: update docs on making releases

---------

Co-authored-by: Colm Talbot <talbotcolm@gmail.com>
mj-will added a commit to mj-will/bilby that referenced this pull request Feb 19, 2026
* BLD: use release branch semver

* DOC: update `making releases` to describe process using release branches

* DOC: fix typo

Co-authored-by: Colm Talbot <talbotcolm@gmail.com>

* DOC: update docs on making releases

---------

Co-authored-by: Colm Talbot <talbotcolm@gmail.com>
isaaclegred pushed a commit to isaaclegred/bilby that referenced this pull request Mar 7, 2026
* BLD: use release branch semver

* DOC: update `making releases` to describe process using release branches

* DOC: fix typo

Co-authored-by: Colm Talbot <talbotcolm@gmail.com>

* DOC: update docs on making releases

---------

Co-authored-by: Colm Talbot <talbotcolm@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants