Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create release change logs #437

Closed
Tracked by #346
manasaV3 opened this issue Feb 2, 2024 · 0 comments
Closed
Tracked by #346

Create release change logs #437

manasaV3 opened this issue Feb 2, 2024 · 0 comments
Assignees
@codemonkey800
Labels
maintenance P0 Must have
Milestone
OLD - sprint 3 (p...

Comments

@manasaV3
Copy link
Contributor

manasaV3 commented Feb 2, 2024 •
edited
Loading

For a release, updates the version, creates change log, tags branch with version, and outputs the version.

Tasks:

  • Create a commit to add changelog inside the relevant folder
  • Push commit to main
  • Tag branch with version
@manasaV3 manasaV3 mentioned this issue Feb 2, 2024
Closed
3 tasks
@manasaV3 manasaV3 changed the title Create release change logs ( ) Create release change logs Feb 2, 2024
@manasaV3 manasaV3 mentioned this issue Feb 5, 2024
Closed
5 tasks
@junxini junxini added the P0 Must have label Feb 8, 2024
@codemonkey800 codemonkey800 mentioned this issue Feb 20, 2024
Merged
@junxini junxini added this to the sprint 3 (phase 3) milestone Feb 20, 2024
codemonkey800 added a commit that referenced this issue Feb 21, 2024
@codemonkey800
release changelog workflow (#476)
f208407 
#437

Implements a workflow for automating the creation of changelogs for the
frontend release. This will ensure the following happens:

- A release PR is created from commits within the `frontend/` directory
using the last release as a comparison.
- The SHA
[79825da](79825da)
is used as a starting point for the first release
- Commits will need to follow the [conventional commits
spec](https://www.conventionalcommits.org/en/v1.0.0/)
- The release PR is automatically merged into `main`
- The labels for the release PR are updated to reflect it being merged
- A Git tag is created on GitHub in the format
`frontend-v{major}-{minor}-{patch}`

## Demo

### Release PR

https://github.com/codemonkey800/cryoet-data-portal/pull/41

<img width="1259" alt="image"
src="https://github.com/chanzuckerberg/cryoet-data-portal/assets/2176050/19cc57fc-da74-4613-b01e-441461c1e45e">

#### Categorization

<img width="560" alt="image"
src="https://github.com/chanzuckerberg/cryoet-data-portal/assets/2176050/215b41da-8121-4741-8c51-9e5a47eacea9">

<img width="414" alt="image"
src="https://github.com/chanzuckerberg/cryoet-data-portal/assets/2176050/13e593ed-e8ab-4d85-a7a3-7d293e5803ef">

### Git Tag


https://github.com/codemonkey800/cryoet-data-portal/releases/tag/frontend-v2.0.0

<img width="643" alt="image"
src="https://github.com/chanzuckerberg/cryoet-data-portal/assets/2176050/39b3dcb4-1492-4070-9df6-c23489894329">
@codemonkey800 codemonkey800 mentioned this issue Feb 26, 2024
Merged
codemonkey800 added a commit that referenced this issue Feb 28, 2024
@codemonkey800
chore: fix release workflow (#508)
1cf95e6 
#437

- Rename package name to `cryoet-data-portal-web` to be clearer it's a
frontend tag
- Adds workflow to generate frontend release PR for every push to main
  - Any existing PRs will edited to include the updated changelog
- Refactored the prod workflow
  - Fix issue with workflow not detecting previous release tags
  - Able to tag a release after PR is merged
- Adds a comment to the PR with a link to the tag the PR was released in
- Add workflow dispatch option to deploy to Terraform and skip PR
merging + tagging

## Demos

All example runs, PRs, and tags can be found in my fork:
https://github.com/codemonkey800/cryoet-data-portal

<img width="666" alt="image"
src="https://github.com/chanzuckerberg/cryoet-data-portal/assets/2176050/aab52d96-95cd-435b-845a-9fffb9da144d">

<img width="371" alt="image"
src="https://github.com/chanzuckerberg/cryoet-data-portal/assets/2176050/f516cbc8-2cee-48b6-80cb-7daa27c5314b">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@codemonkey800 codemonkey800

Labels
maintenance P0 Must have
Projects
None yet
Milestone
OLD - sprint 3 (phase 3)
Development

No branches or pull requests
3 participants
@codemonkey800 @manasaV3 @junxini