Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Chore/release process improvements #130

Merged
merged 43 commits into from
May 6, 2020
Merged
Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
a57bd89
chore(release): one-app release process improvements
nellyk Apr 22, 2020
6d1739e
chore(release): one-app release process improvements
nellyk Apr 22, 2020
197fbfe
chore(release): one-app release process improvements
nellyk Apr 22, 2020
207cfed
Merge branch 'master' into chore/release-process-improvements
JAdshead Apr 22, 2020
5cb34fc
Merge branch 'master' into chore/release-process-improvements
Apr 23, 2020
1a42705
chore(release): pr review comments
nellyk Apr 24, 2020
762166d
Merge branch 'master' into chore/release-process-improvements
nellyk Apr 27, 2020
721dd1d
chore(release): update release process as per pr review
nellyk Apr 27, 2020
412f4cb
chore(workflows): tagging regex update
nellyk Apr 27, 2020
bcf834b
chore(release): pr review changes
nellyk Apr 28, 2020
87cf4ce
chore(release): docker regex update
nellyk Apr 28, 2020
0ff749f
Merge branch 'master' into chore/release-process-improvements
JAdshead Apr 28, 2020
cf85e7f
chore(release): update docker regex
nellyk Apr 28, 2020
09d3fd9
chore(release): update as per pr review
nellyk Apr 28, 2020
59831a2
chore(release): update workflow name
nellyk Apr 28, 2020
9a39281
chore(release): update changelog message
nellyk Apr 29, 2020
3e0424b
chore(release): pr review changes
nellyk Apr 29, 2020
b5982fa
chore(release): review comments
nellyk Apr 29, 2020
9ca33de
Merge branch 'master' into chore/release-process-improvements
Francois-Esquire Apr 29, 2020
da17779
chore(package): remove conventional commit
nellyk Apr 29, 2020
f3b7d32
chore(package): remove conventional commit
nellyk Apr 29, 2020
33c2e6f
chore(package): remove conventional commit
nellyk Apr 29, 2020
1f47ded
chore(package): remove conventional commit
nellyk Apr 29, 2020
bb846f6
chore(package): remove conventional commit
nellyk Apr 29, 2020
e9e836b
Merge branch 'master' into chore/release-process-improvements
nellyk Apr 30, 2020
bf4ff39
chore(release): update docker script
nellyk Apr 30, 2020
ed22f51
chore(release): update changelog generation
nellyk May 5, 2020
0415f55
chore(release): update docs
nellyk May 5, 2020
871c283
Merge branch 'master' into chore/release-process-improvements
nellyk May 5, 2020
fbcb176
chore(release): update docs
nellyk May 5, 2020
c739896
Merge branch 'chore/release-process-improvements' of https://github.c…
nellyk May 5, 2020
0132a01
chore(release): update docs
nellyk May 5, 2020
9d0c3b2
chore(release): update docs
nellyk May 5, 2020
c43e5b6
chore(release): update docs
nellyk May 5, 2020
37aea5e
chore(release): update changelog script
nellyk May 6, 2020
2d3ebb2
chore(release): update docs
nellyk May 6, 2020
0a93fe0
Merge branch 'chore/release-process-improvements' of https://github.c…
nellyk May 6, 2020
a399477
chore(release): release docs update
nellyk May 6, 2020
12eb08c
chore(release): update docs
nellyk May 6, 2020
fa4dafa
chore(package): update release script
nellyk May 6, 2020
ef15e3c
Merge branch 'master' into chore/release-process-improvements
nellyk May 6, 2020
e1d3dd1
chore(release): update docs
nellyk May 6, 2020
55f8923
chore(release): update docs
nellyk May 6, 2020
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
Prev Previous commit
Next Next commit
chore(release): update docs
  • Loading branch information
nellyk committed May 5, 2020
commit fbcb176fa4e98dc07b0a451d8f222402de372a63
10 changes: 5 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Releases can be triggered in two ways:

## Automated release process

1. An automated pull request will be raised every Wednesday at 16:00 UTC, from a `prepare-release` branch to master. This uses [pull_request_release workflow](.github/workflows/pull_request_release.yml) and updates the [package.json](package.json), [package-lock.json](package-lock.json), [one-app-statics package.json](one-app-statics/package.json) and runs `npm run release:changelog` to generate the changelog. Behind the scene it uses [standard-version](https://github.com/conventional-changelog/standard-version) to generate and update these files with the changes for released. The commit message contains will be in the following format `chore(release): X.X.X` . You can update this pull request to remove or add any new changes.
2. Once a pull request is reviewed merge the pull request and please ensure that the commit message is updated to follow this pattern
1. An automated pull request will be raised every Wednesday at 16:00 UTC, from a `prepare-release` branch to master. This uses [pull_request_release workflow](.github/workflows/pull_request_release.yml) and updates the [package.json](package.json), [package-lock.json](package-lock.json), [one-app-statics package.json](one-app-statics/package.json) and runs `npm run release:changelog` to generate the changelog. Behind the scene it uses [standard-version](https://github.com/conventional-changelog/standard-version) to update these file versions and [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) to generate the changelog. The commit message will be in the following format `chore(release): X.X.X` . You can update this pull request to remove or add any new changes.
2. Once a pull request is reviewed, merge the pull request and please ensure that the commit message is updated to follow this pattern

``` bash
#chore(release): 5.0.0
Expand Down Expand Up @@ -61,16 +61,16 @@ If changes were made and need to be reverted. Please use the [manual release pro

### How can I run the first release?

For the first release please use the [manual release process](#manual-release-process). Run `npm run release -- --first-release` to generate the initial changelog and update the package.json files.
For the first release please use the [manual release process](#manual-release-process). Run `npm run release -- --first-release` to update the package.json files.

### How can I create a prerelease?

For the first release please use the [manual release process](#manual-release-process). Run `npm run release -- --prerelease` to generate the initial changelog and update the package.json files.
For the first release please use the [manual release process](#manual-release-process). Run `npm run release -- --prerelease` to update the package.json files.

### What happens if a pull request merged after the automated pull request is created?

We should try to prevent this from happening, but if it does happen, trigger the pull request to update by typing `/prepare-release` once that has completed a 🚀 and 👀 reaction would be added to the comment.

### How can I do a dry run to test out the files to be changed locally

Locally you can run `npm run release -- --dry-run`, this would show the new version to be released, the files that would changed and a view of the changelog without changing any of the files.
Locally you can run `npm run release -- --dry-run`, this would show the new version to be released and the files that would changed.