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

Conversation

nellyk
Copy link
Contributor

@nellyk nellyk commented May 5, 2020

Description

Motivation and Context

Improve the One App release process

How Has This Been Tested?

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (adding or updating documentation)

Checklist:

  • My change requires a change to the documentation and I have updated the documentation accordingly.
  • These changes should be applied to a maintenance branch.
  • This change requires cross browser checks.
  • Performance tests should be ran against the server prior to merging.
  • This change impacts caching for client browsers.
  • This change impacts HTTP headers.
  • This change adds additional environment variable requirements for One App users.
  • I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using One App?

No impact, improves the release process for the One App

nellyk and others added 28 commits April 22, 2020 13:58
Co-Authored-By: Jonny Adshead <JAdshead@users.noreply.github.com>
Co-Authored-By: Jonny Adshead <JAdshead@users.noreply.github.com>
Co-Authored-By: Jonny Adshead <JAdshead@users.noreply.github.com>
Co-Authored-By: Jonny Adshead <JAdshead@users.noreply.github.com>
Co-Authored-By: Jonny Adshead <JAdshead@users.noreply.github.com>
Co-Authored-By: Mike Tobia <Francois-Esquire@users.noreply.github.com>
Co-Authored-By: Mike Tobia <Francois-Esquire@users.noreply.github.com>
@nellyk nellyk requested review from a team as code owners May 5, 2020 11:34
mtomcal
mtomcal previously approved these changes May 5, 2020
package.json Outdated Show resolved Hide resolved
infoxicator
infoxicator previously approved these changes May 6, 2020
Co-authored-by: Mike Tobia <Francois-Esquire@users.noreply.github.com>
@nellyk nellyk dismissed stale reviews from infoxicator and mtomcal via 37aea5e May 6, 2020 11:53
@nellyk
Copy link
Contributor Author

nellyk commented May 6, 2020

Really digging the documentation @nellyk.

Thank you 😄

RELEASE.md Outdated Show resolved Hide resolved
Co-authored-by: Mike Tobia <Francois-Esquire@users.noreply.github.com>
RELEASE.md Outdated
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.

RELEASE.md Outdated
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.
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

RELEASE.md Outdated
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.
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.

RELEASE.md Outdated

### 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

infoxicator
infoxicator previously approved these changes May 6, 2020
@nellyk nellyk dismissed stale reviews from infoxicator and Francois-Esquire via fa4dafa May 6, 2020 17:03
@nellyk nellyk merged commit 3fe36a8 into master May 6, 2020
@nellyk nellyk deleted the chore/release-process-improvements branch May 6, 2020 18:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants