raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-02-17 00:07:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Releasing (markdown)

Matt-Yorkley
2020-01-23 16:16:22 +01:00
parent 6ff1772f3d
commit 98f4bdf55f
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Releasing.md

@@ -47,7 +47,7 @@ Download all current translations from Transifex with the [Transifex client](htt
### Collect included changes
Identify all pull requests that got merged since the last release.
- Option 1: You can look at the [last release](https://github.com/openfoodfoundation/openfoodnetwork/releases/latest) and use the date of the pinned commit to [filter pull requests](https://github.com/openfoodfoundation/openfoodnetwork/pulls?utf8=%E2%9C%93&q=is%3Apr+merged%3A%3E2020-01-16T20%3A00%3A00%2B02%3A00+sort%3Aupdated-desc+base%3Amaster) putting the date and time into the filter box like this: `is:pr merged:>2020-01-16T21:37:00+01:00 sort:updated-desc base:master`
- Option 1: You can look at the [last release](https://github.com/openfoodfoundation/openfoodnetwork/releases/latest) and **use the date of the pinned commit** to [filter pull requests](https://github.com/openfoodfoundation/openfoodnetwork/pulls?utf8=%E2%9C%93&q=is%3Apr+merged%3A%3E2020-01-16T20%3A00%3A00%2B02%3A00+sort%3Aupdated-desc+base%3Amaster) putting the date and time into the filter box like this: `is:pr merged:>2020-01-16T21:37:00+01:00 sort:updated-desc base:master`
- Option 2: You can list all pull requests with git and open them in your browser:
```
git fetch upstream
@@ -59,17 +59,21 @@ Identify all pull requests that got merged since the last release.
### Draft the release
Draft a [new release](https://github.com/openfoodfoundation/openfoodnetwork/releases/new) in the Github UI. **Base the release on the commit with the last merged PR you want to include** ('Target->Recent Commits') and not `master`. There's always a chance new PR's are merged between the draft is created and the actual release is published, so this makes the release consistent. If you take a look at the master branch in [Semaphore](https://semaphoreci.com/openfoodfoundation/openfoodnetwork-2/branches/master), you should see the Transifex commit you made in the steps above ("Update all locales with the latest Transifex translations").
Draft a [new release](https://github.com/openfoodfoundation/openfoodnetwork/releases/new) in the Github UI. **Base the release on the commit with the last merged PR you want to include** ('Target->Recent Commits') and not `master`. There's always a chance new PR's are merged between the draft is created and the actual release is published, so this makes the release consistent. If you take a look at the master branch in [Semaphore](https://semaphoreci.com/openfoodfoundation/openfoodnetwork-2/branches/master), you should see the Transifex commit you just made in the steps above (named "Update all locales with the latest Transifex translations").
**Make sure the notes can be understood by humans** using the types of changes specified by [Keep a changelog](https://keepachangelog.com) and use only the sections that have at least one PR in it. Keep in mind these notes are the source of truth for everyone: devs, product people and users. Mention any dependencies on [ofn-install](https://github.com/openfoodfoundation/ofn-install) as well.
Unless agreement has been reached in the [#dev](https://openfoodnetwork.slack.com/messages/C2GQ45KNU) Slack channel that a major release is appropriate, releases only bump up the minor version (eg: from 1.16.0 to 1.17.0).
## Update the Github issue
Add a link to the **target commit** for the new release, a link to the newly deafted release, and a link to the **Semaphore build** for that commit into the Github issue for the release so the release tester has a nice time :heart:.
## Testing the release
Releases require some testing to ensure critical paths of the application keep working. Talk to one of the testers available to coordinate this. Once the release's draft is finished and she is aware, stage `master` to a server with PayPal and Stripe integrations set up. These need to be tested.
Releases require some testing to ensure critical paths of the application keep working. Talk to one of the testers available to coordinate this (message in the #testing channel). Once the release's draft is finished and she is aware, you can **stage the target commit via the Semaphore build page** to a server with PayPal and Stripe integrations set up. These need to be tested.
Keep in mind that any merges done to `master` while the release is in draft won't get tested unless we stage again. We don't have a specific release branch; we just have `master` and tag release version in it.
Keep in mind that any merges done to `master` while the release is in draft won't get tested unless we stage again. We don't have a specific release branch; we just have `master` and tag release versions to pinned commits in it.
## Publish the release