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
Show file tree
Hide file tree
Changes from 6 commits
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
3 changes: 1 addition & 2 deletions .github/workflows/pull_request_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ jobs:
NODE_ENV=development npm ci
git config --local user.email "one.amex@aexp.com"
git config --local user.name "OneAmexBot"
npm run release -- --no-verify
npm run release:changelog
npm run release
git add .
git commit -m "docs(changelog): update"
- name: Create release pull request
Expand Down
30 changes: 15 additions & 15 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)
3. The statics assets will be published and added to the tag created via the [release static assets action](.github/workflows/docker_release.yml) as part of the previous step.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The 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.
If we take the changes add as part of the changelog do we even need release drafter ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you mean by "tie it" ?

Suggested change
5. Update the draft release notes with any changes required and tie it to the released tag.
5. Update the draft release notes with any changes required and edit the released tag to add them there.

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]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is all this white space necessary ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@
"set-middleware": "set-middleware",
"set-dev-endpoints": "node scripts/set-dev-endpoints.js",
"postinstall": "npm run build",
"release:changelog": "echo -e \"$(head -3 CHANGELOG.md)\n\n$(node_modules/.bin/conventional-changelog -p angular)\n\n$(tail -n +3 CHANGELOG.md)\" > CHANGELOG.md",
"release": "standard-version"
"release:standard-version": "standard-version -- --no-verify",
"release:changelog": "echo -e \"$(head -3 CHANGELOG.md)\n\n$(node_modules/.bin/conventional-changelog -p angular)\n\n$(tail -n +4 CHANGELOG.md)\" > CHANGELOG.md",
"release": "release:standard-version && release:changelog"
},
"repository": {
"type": "git",
Expand Down