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.

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

Release template #732

Merged
merged 6 commits into from
Jan 21, 2025
Merged

Release template #732

merged 6 commits into from
Jan 21, 2025

Conversation

i-oden
Copy link
Member

@i-oden i-oden commented Jan 17, 2025

Read this before submitting the PR

  1. Always create a Draft PR first
  2. Go through sections 1-5 below, fill them in and check all the boxes
  3. Make sure that the branch is updated; if there's an "Update branch" button at the bottom of the PR, rebase or update branch.
  4. When all boxes are checked, information is filled in, and the branch is updated: mark as Ready For Review and tag reviewers (top right)
  5. Once there is a submitted review, implement the suggestions (if reasonable, otherwise discuss) and request an new review.

If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.

1. Description / Summary

Same as ScilifelabDataCentre/dds_web#1587

2. Jira task / GitHub issue

Is this a GitHub issue? --> Add the link to the github issue

Is this from a Jira task? --> If your branch does not contain info regarding the Jira task ID, put it here.

3. Type of change - Add label

What type of change(s) does the PR contain? For an explanation of the different options below, enter edit mode of this PR description template.

If you do not want this change to be included in release notes, add the label skip-changelog.

  • New feature
    • Breaking --> label: breaking
    • Non-breaking --> label: feature
  • Database change --> label: feature or none at all.
    Remember the to include a new migration version, or explain here why it's not needed.
  • Bug fix --> label: bug
  • Security Alert fix
    • Package update --> label: dependency
      • Major version update
  • Documentation --> label can be skipped, will be included in "other changes"
  • Workflow --> label: skip-changelog
  • Tests only --> label: skip-changelog

4. Additional information

5. Actions / Scans

Make sure that the following checks/actions have passed.

  • Black
  • Prettier
  • Pylint
  • Yamllint
  • Tests
  • CodeQL
  • Trivy
  • Snyk
  • TestPyPI

If an action does not pass and you need help with how to solve it, enter edit mode of this PR template or go to the PR template.

@i-oden i-oden self-assigned this Jan 17, 2025
@i-oden i-oden added the skip-changelog For release template label Jan 17, 2025
@i-oden i-oden marked this pull request as ready for review January 17, 2025 15:43
@i-oden i-oden requested a review from a team as a code owner January 17, 2025 15:43
Copy link
Member

@rv0lt rv0lt left a comment

Choose a reason for hiding this comment

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

Description and Jira link missing, besides that. Like it!

@i-oden
Copy link
Member Author

i-oden commented Jan 21, 2025

Description and Jira link missing, besides that. Like it!

I've updated the decription (added link to the dds_web release template PR) ✅
Regarding the Jira link -- the PR template is updated. The branch name contains the info regarding the jira task. If we want to keep adding the jira link we can discuss it at some point but then we'll make a new PR to update the PR template as well 👍🏻

@i-oden i-oden requested a review from rv0lt January 21, 2025 11:24
@i-oden i-oden merged commit 1ef663d into dev Jan 21, 2025
15 checks passed
@i-oden i-oden deleted the HMS-2280-release-template branch January 21, 2025 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog For release template
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants