diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6b652dacf..f9e2379e4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,77 +10,78 @@ If there is a field which you are unsure about, enter the edit mode of this desc ## 1. Description / Summary -_Add a summary of the changes in this PR and the related issue._ +**Add a summary here**: What does this PR add/change and why? ## 2. Jira task / GitHub issue -_Link to the github issue or add the Jira task ID here._ +**Is this a GitHub issue?** --> Add the link to the github issue -## 3. Type of change +**Is this from a Jira task?** --> If your branch does not contain info regarding the Jira task ID, put it here. -What _type of change(s)_ does the PR contain? +## 3. Type of change - Add label -**Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.** +**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.** -- [ ] New feature - - [ ] Breaking: _Why / How? Add info here._ - - [ ] Non-breaking -- [ ] Database change: _Remember the to include a new migration version, **or** explain here why it's not needed._ -- [ ] Bug fix -- [ ] Security Alert fix - - [ ] Package update - - [ ] Major version update -- [ ] Documentation -- [ ] Workflow -- [ ] Tests **only** +_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 -- [ ] [Sprintlog](../SPRINTLOG.md) -- [ ] Blocking PRs - - [ ] Merged -- [ ] PR to `master` branch: \_If checked, read [the release instructions](../doc/procedures/new_release.md) +- [ ] I have added an entry to the [Sprintlog](../SPRINTLOG.md) +- [ ] This is a PR to the `master` branch: _If checked, read [the release instructions](../doc/procedures/new_release.md)_ - [ ] I have followed steps 1-8. ## 5. Actions / Scans -_Check the boxes when the specified checks have passed._ - -**For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the [PR template](../.github/pull_request_template.md).** +**Make sure that the following checks/actions have passed.** -- [ ] **Black** +- **Black** -- [ ] **Prettier** +- **Prettier** -- [ ] **Yamllint** +- **Yamllint** -- [ ] **Tests** +- **Tests** -- [ ] **CodeQL** +- **CodeQL** -- [ ] **Trivy** +- **Trivy** -- [ ] **Snyk** +- **Snyk** + +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](../.github/pull_request_template.md). diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..07c0bf58f --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,23 @@ +# file location/name: .github/release.yml +changelog: + exclude: + labels: # A list of labels that exclude a pull request from appearing in release notes. + - skip-changelog + authors: # A list of user or bot login handles whose pull requests are to be excluded from release notes. + - dependabot[bot] + categories: + - title: 🚀 Features + labels: + - feature + - title: 🐛 Bug Fixes + labels: + - bug + - title: ⛓️‍💥 Breaking Changes + labels: + - breaking + - title: 🛡️ Dependencies + labels: + - dependency + - title: Other Changes + labels: + - "*" # Catch-all for pull requests that didn't match any of the previous categories diff --git a/SPRINTLOG.md b/SPRINTLOG.md index 4c3ad9df1..7d1137477 100644 --- a/SPRINTLOG.md +++ b/SPRINTLOG.md @@ -473,3 +473,7 @@ _Nothing merged during this sprint_ - New version: 2.9.0 ([#1584](https://github.com/ScilifelabDataCentre/dds_web/pull/1584)) - Instructions regarding database migrations moved to migrations directory, and Linkspector action added to scan for incorrect links in MD ([#1576](https://github.com/ScilifelabDataCentre/dds_web/pull/1576)) + +# 2024-12-20 - 2025-01-10 + +- Make release template ([1587](https://github.com/ScilifelabDataCentre/dds_web/pull/1587)) diff --git a/doc/procedures/new_release.md b/doc/procedures/new_release.md index 82bd4fbe4..292ebe1f3 100644 --- a/doc/procedures/new_release.md +++ b/doc/procedures/new_release.md @@ -10,7 +10,7 @@ 3. Fork a new branch from `dev` (locally) 4. Update the version [changelog](../../CHANGELOG.rst), located at `dds_web/CHANGELOG.rst` - **Tip:** Use the PR to `master` to see all changes since last release. + **Tip:** Create a [release **draft**](https://github.com/ScilifelabDataCentre/dds_web/releases/new) with `Target: dev`, click `Generate release notes` and copy paste the release notes into the Changelog. **DO NOT PUBLISH THE RELEASE** - The new version should be at the top of the page - List the changes that the users will / may notice @@ -56,46 +56,4 @@ An image of the web / api will be published to the [GitHub Container Registry](https://codefresh.io/csdp-docs/docs/integrations/container-registries/github-cr/) -10. Perform redeployment - - The method for this _depends on the situation_ / size of and reason for the upgrade. - - - **Bug**, affecting the DDS functionality - Fix ASAP - - 1. Add a new _Message of the Day_ (MOTD) informing the users of an ongoing / immediate update - (see CLI) - 2. Send the MOTD via email (see CLI) - 3. Send a message in the `dds-status` slack channel to inform the units - 4. Ask for a redeployment - - 1. Go to the [sysadmin repository](https://github.com/ScilifelabDataCentre/sysadmin/issues) - 2. Create a new issue and fill in the following information - - `Title` - - DDS: Redeploy the production instance (`dds`) - - `Leave a comment` - - Please redeploy the production instance of the DDS. - Image: - - Fill in the [manual log](https://scilifelab.atlassian.net/wiki/spaces/deliveryportal/pages/2318565390/Production) on Confluence. - - - **New feature** or bug that does not need an immediate fix - - Cluster maintenance is performed the first Wednesday (that is a work day) of every month. The DDS is redeployed during this as well. However, we still need to inform the users of the upcoming upgrade, and the sysadmins of which image they should deploy. - - 1. Go to the [sysadmin repository](https://github.com/ScilifelabDataCentre/sysadmin/issues) - 2. Create a new issue and fill in the following information - - `Title` - - DDS: Schedule redeployment of production instance (`dds`) for next cluster maintenance window - - `Leave a comment` - - During the next cluster maintenance (``), please redeploy the production instance of the DDS. - - Image: - - Fill in the [manual log](https://scilifelab.atlassian.net/wiki/spaces/deliveryportal/pages/2318565390/Production) on Confluence. +10. Perform redeployment during maintenance window.