-
Notifications
You must be signed in to change notification settings - Fork 87
Chore/release process improvements #130
Changes from 6 commits
a57bd89
6d1739e
197fbfe
207cfed
5cb34fc
1a42705
762166d
721dd1d
412f4cb
bcf834b
87cf4ce
0ff749f
cf85e7f
09d3fd9
59831a2
9a39281
3e0424b
b5982fa
9ca33de
da17779
f3b7d32
33c2e6f
1f47ded
bb846f6
e9e836b
bf4ff39
ed22f51
0415f55
871c283
fbcb176
c739896
0132a01
9d0c3b2
c43e5b6
37aea5e
2d3ebb2
0a93fe0
a399477
12eb08c
fa4dafa
ef15e3c
e1d3dd1
55f8923
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -21,28 +21,28 @@ Releases can be triggered in two ways: | |||||
> Integration tests will continue to run in Travis as they currently do, after the automated pull request is created it would run the tests on `prepare-release` branch. | ||||||
|
||||||
1. The merge will trigger the automatic generation of a new tag using the semantic version provided during the merging of the pull request above. | ||||||
|
||||||
2. After the the generated tag is pushed to the branch this will trigger the docker build and publish the statics and push the images to Docker Hub. The development and production images would be accessible in docker [https://hub.docker.com/u/oneamex](https://hub.docker.com/u/oneamex) | ||||||
3. The statics assets will be published and added to a tag that has been released via the [release static assets action](.github/workflows/docker_release.yml) | ||||||
4. We are currently using [https://github.com/release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) to generate release notes. This is a github action that generates draft releases note that can be added to the released tag. Please add the labels specified within [release-drafter](.github/release-drafter.yml) to categorize different pull requests to ensure that any changes are categorized correctly. You can also use the changelog generated for this content. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. does release-drafter have to use labels or can it use commits ? can we auto label based of the commit. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We have some work to address this in a separate PR |
||||||
5. Update the draft release notes with any changes required and tie it to the released tag. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what do you mean by "tie it" ?
Suggested change
|
||||||
6. For the release notes use the below format. Please review some of the releases to check the format used [https://github.com/americanexpress/one-app/releases](https://github.com/americanexpress/one-app/releases) | ||||||
|
||||||
3. We are currently using [https://github.com/release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) to generate release notes. Please add the labels specified within [release-drafter](.github/release-drafter.yml) to categorize different pull requests. Update the draft release notes and tie it to the release tag above, you can also link this to different artifacts. The statics assets will be published and added to a tag that has been released. | ||||||
4. For the release notes use the below format, checkout [https://github.com/americanexpress/one-app/releases](https://github.com/americanexpress/one-app/releases) | ||||||
|
||||||
``` | ||||||
|
||||||
[Paste changelog entries here] | ||||||
|
||||||
### Docker Images | ||||||
``` | ||||||
[Paste changelog entries here] | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is all this white space necessary ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove this, i had missed this earlier |
||||||
|
||||||
### Docker Images | ||||||
|
||||||
#### Developer Image | ||||||
[one-app-dev/version-released](https://hub.docker.com/layers/oneamex/one-app-dev/link-to-the-docker-tag) | ||||||
#### Developer Image | ||||||
[one-app-dev/version-released](https://hub.docker.com/layers/oneamex/one-app-dev/link-to-the-docker-tag) | ||||||
|
||||||
#### Production Image | ||||||
[one-app/version-released](https://hub.docker.com/layers/oneamex/one-app/link-to-the-docker-tag) | ||||||
#### Production Image | ||||||
[one-app/version-released](https://hub.docker.com/layers/oneamex/one-app/link-to-the-docker-tag) | ||||||
|
||||||
### One App Statics | ||||||
https://www.npmjs.com/package/@americanexpress/one-app-statics | ||||||
### One App Statics | ||||||
https://www.npmjs.com/package/@americanexpress/one-app-statics | ||||||
|
||||||
``` | ||||||
7. | ||||||
|
||||||
## Manual release process | ||||||
|
||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.