Skip to content

Update PR template and remove duplicates in release procedure #756

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.

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

Merged
merged 4 commits into from
May 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ If there is a field which you are unsure about, enter the edit mode of this desc
## 4. Additional information

- [ ] I have added an entry to the [Sprintlog](../SPRINTLOG.md) <!-- Add a row at the bottom of the SPRINTLOG.md file (not needed if PR contains only tests). Follow the format of previous rows. If the PR is the first in a new sprint, add a new sprint header row (follow the format of previous sprints). -->
- [ ] This is a PR to the `master` branch: _If checked, read [the release instructions](../doc/procedures/new_release.md)_ <!-- Check this if the PR is made to the `master` branch. Only the `dev` branch should be doing this. -->
- [ ] I have followed steps 1-8. <!-- Should be checked if the "PR to `master` branch" box is checked AND the specified steps in the release instructions have been followed. -->
- [ ] This is a PR to the `master` branch: _If checked, read [the release instructions](../docs/procedures/new_release.md)_ <!-- Check this if the PR is made to the `master` branch. Only the `dev` branch should be doing this. -->
- [ ] I have followed steps 1-9. <!-- Should be checked if the "PR to `master` branch" box is checked AND the specified steps in the release instructions have been followed. -->

## 5. Actions / Scans

Expand Down
1 change: 1 addition & 0 deletions SPRINTLOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,3 +431,4 @@ _Empty sprint_
- Edit structure of release template ([#752](https://github.com/ScilifelabDataCentre/dds_cli/pull/752))
- New version: 2.10.2 ([#754](https://github.com/ScilifelabDataCentre/dds_cli/pull/754))
- Update instructions regarding release procedure ([#755](https://github.com/ScilifelabDataCentre/dds_cli/pull/755))
- Update PR template and remove duplicates in release procedure ([#756](https://github.com/ScilifelabDataCentre/dds_cli/pull/756))
38 changes: 0 additions & 38 deletions docs/procedures/new_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,44 +20,6 @@ When changes are pushed to `dev` or `master`, a Draft Release is created/updated

## Go through these steps

1. Create a PR from `dev` to `master` and verify that the PRs included in the changes have the correct labels.

> Check out the [Release Drafter config file](../../.github/release-drafter.yml) and/or the [PR template](../../.github/pull_request_template.md) for info on which code changes give which labels.

2. Check the release draft: Does the suggestion version seem appropriate? If not: Check the PRs and their labels, again.

> **Note** that a _major version upgrade SHOULD NEVER BE DONE UNLESS THE API ALSO HAS THIS IDENTICAL CHANGE_

3. Fork a new branch from `dev`: `new-version_[new version]`
4. Update the version in [`version.py`](../../dds_cli/version.py)
5. Update the [changelog](../../CHANGELOG.rst).

> Copy-paste the contents of the release draft into the top of the changelog; Follow the same structure/format as previous versions.

6. Push the changelog and version to the `new-version_[new version]` branch
7. Run the `rich-codex` action [here](https://github.com/ScilifelabDataCentre/dds_cli/actions/workflows/rich-codex-cli.yml); Choose the `new-version_[new version]` branch in the "Run workflow" drop-down button
# How to create a new release

> ### Inform the users of an upcoming release
>
> Always inform users of an upcoming new release _at least_ a week prior to a new release:
>
> 1. Adding a "Message of the Day": `dds motd add`
> 2. Getting the MOTD ID: `dds motd ls`
> 3. Sending the MOTD to the users: `dds motd send [MOTD ID]`
>
> **Important**
>
> - If users do not upgrade the CLI when there is a new version, they may experience issues and errors.
> - If there is a major version mismatch between the API and CLI (e.g. API version 1.0.0 and CLI version 2.0.0 or vice versa), the DDS will inform the users that they are blocked from using the DDS until they have upgraded.
> - If there is no warning from the DDS and there is an error, the first thing they should do is verify that the `dds-cli` version is up to date

## Automatic Release Drafts

When changes are pushed to `dev` or `master`, a Draft Release is created/updated. The draft will be displayed here: https://github.com/ScilifelabDataCentre/dds_cli/releases. The draft will also have a suggestion for what the next version should be, based on PR labels.

## Go through these steps

1. Create a PR from `dev` to `master` and verify that the PRs included in the changes have the correct labels.

> Check out the [Release Drafter config file](../../.github/release-drafter.yml) and/or the [PR template](../../.github/pull_request_template.md) for info on which code changes give which labels.
Expand Down
Loading