Skip to content

Commit

Permalink
πŸ“ enhancing release workflow + adding hotfix template (#4083)
Browse files Browse the repository at this point in the history
  • Loading branch information
matusdrobuliak66 authored Apr 11, 2023
1 parent 8868869 commit db03239
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4_pre_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ body:
Log any issues since this procedure should be taken also as an exercise in preparation for the release to production as well.
value: |
- [ ] Add changes (if any) and release tags in https://github.com/ITISFoundation/osparc-ops-environments/tags
- [ ] Add changes (if any) and release tags in osparc ops configurations
- [ ] Add changes (if any) and release tags in **osparc-ops-deployment-configuration** (osparc.io & speag.com)
- [ ] ...
validations:
required: false
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/5_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ body:
attributes:
label: "Previous pre-release"
description: |
Link to pre-release to staging tha preceeds this release
Link to pre-release to staging that preceeds this release
value: https://github.com/ITISFoundation/osparc-simcore/releases/tag/staging_<sprint_name><version>
validations:
required: true
Expand Down Expand Up @@ -70,7 +70,7 @@ body:
Log below completed steps and issues
value: |
- [ ] Add changes (if any) and release tags in https://github.com/ITISFoundation/osparc-ops-environments/tags
- [ ] Add changes (if any) and release tags in osparc ops configurations
- [ ] Add changes (if any) and release tags in **osparc-ops-deployment-configuration** (osparc.io & speag.com)
- [ ] ...
validations:
required: false
Expand Down Expand Up @@ -123,7 +123,7 @@ body:
- [ ] aws
- [ ] dalco
- [ ] tip
- status page
- status page (https://manage.statuspage.io/)
- [ ] osparc
- [ ] s4l
- mattermost channels
Expand Down
89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/6_hotfix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: πŸš‘οΈ Hotfix (developers-only)
description: Critical hotfix to staging or production
title: 'πŸš‘οΈ Release <staging_hotfix/v.X.Y.Z> (hotfix)'
labels: ["t:maintenance", "release"]
assignees: ["pcrespov"]
body:
- type: input
id: version
attributes:
label: Release version
description: Release version as major.minor.patch .Check [Releases](https://github.com/ITISFoundation/osparc-simcore/releases)
placeholder: 1.51.1
validations:
required: true
- type: input
id: commit_sha
attributes:
label: Commit SHA
description: |
Selets the commit from which the release takes placeholder. Check [commits](https://github.com/ITISFoundation/osparc-simcore/commits/master)
IMPORTANT: make sure t (i.e. tests passed and images were built and pushed)
placeholder: 8d9a27ebb3e64956e6a41f31839748b3f6a27074
validations:
required: true
- type: input
id: previous_release
attributes:
label: "Previous release"
description: |
Link to release that preceeds this release
value: https://github.com/ITISFoundation/osparc-simcore/releases/tag/<vZ.Y.Z>
validations:
required: true
- type: checkboxes
attributes:
label: Did the commit CI suceeded?
description: Check the CI of the selected commit in the [repo commits](https://github.com/ITISFoundation/osparc-simcore/commits/master) to make sure the images are built and ready
options:
- label: The commit CI succeeded.
required: true
- type: textarea
attributes:
label: Motivation
description: |
What is the motivation to release hotfix to stagging/production?
- Explain what motivates this release?
- Which important changes we might pay attention to?
- How should we test them?
- Is there anything in particular we should monitor?
validations:
required: true
- type: textarea
attributes:
label: "πŸš‘οΈ Hotfix branch"
value: |
- [] create hotfix branch [``hotfix_v1_51_x``](https://github.com/ITISFoundation/osparc-simcore/tree/hotfix_v1_51_x) directly in *upstream* repo. **Do not delete hotfix branches** at least until next *full* release takes place.
- [] prepare hotfix by applying patches/cherry-picks (see *what changed* section)
- [] test hotfix in local deployment @pcrespov
- [] push and [check whether CI passed](https://github.com/ITISFoundation/osparc-simcore/actions)
- [] check [images in dockerhub](https://registry.hub.docker.com/u/itisfoundation)
validations:
required: false
- type: textarea
attributes:
label: Changes
description: |
Changes introduced by this release.
List links to the PRs associated to every commit in the release. This will automatically create references between PRs and this release that will be very valuable for traceability.
TIP: use the autogenerate changelog feature during the draft release.
validations:
required: false
- type: textarea
attributes:
label: Releasing πŸš€
value: |
- ``make release-hotfix version=1.51.1 git_sha=8d9a27ebb3e64956e6a41f31839748b3f6a27074``
- [ ] Draft [release notes](https://github.com/ITISFoundation/osparc-simcore/releases) πŸš€
- [ ] No need for maintenance announcement?: Target update of ``service``
- [ ] Deploy hot-fix.
- [ ] ``autodeployer`` OFF in aws-prod, dalco-prod, ti
- [ ] [release](https://github.com/ITISFoundation/osparc-simcore/releases) πŸš€ !!!!
- [ ] aws-prod (updated target service)
- [ ] dalco-prod (updated target service)
- [ ] ti (updated target service)
- [ ] Test and Monitor. Revert back if needed!
- [ ] Announce hot-fix
``` md
:tada: https://github.com/ITISFoundation/osparc-simcore/releases/tag/v<M.m.0>
```

0 comments on commit db03239

Please sign in to comment.