Skip to content

Add a guide to making a release #1264

@alexdewar

Description

@alexdewar

As suggested in #1262, it might be useful for there to be a guide for developers on how to make a new release, because there are now a few steps involved.

Off the top of my head, this list should include:

  • Checking that the release notes for the "upcoming release" are complete and correct (docs/release_notes/upcoming.md)
  • Rename the file for upcoming release according to the next version, e.g. docs/release_notes/v2.5.0.md
  • Putting a placeholder file for the next upcoming release
  • Bumping the crate version in Cargo.toml
  • Bumping the program version specified in CITATION.cff

There are a few checks related to these in tests/release.rs, but in any case, it would be good to have a set of instructions to help developers along.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    🔖 Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions