Skip to content

Commit

Permalink
[Issue 1056] Adds step by step release instructions (#1057)
Browse files Browse the repository at this point in the history
## Summary
Fixes #1056

### Time to review: __1 mins__
  • Loading branch information
coilysiren authored Feb 5, 2024
1 parent 6b3be7e commit 04c2f9a
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,25 @@ This project takes a very collaborative and [agile](https://agilemanifesto.org/)

## Releases

Releases follow the [CalVer](https://calver.org/) versioning using a `YYYY.MM.DD-N` format. Start with `-1` for a release, incrementing if there is another release on the same day.

Releases should be [created in Github](https://github.com/HHS/simpler-grants-gov/releases) and include a log of changes.
Releases follow the [CalVer](https://calver.org/) versioning using a `YYYY.MM.DD-N` format.

Releases are [created in Github](https://github.com/HHS/simpler-grants-gov/releases) and with a log of changes.

Step by step instructions for creating a release:

- In your terminal, `git switch main` and `git pull` to sync your local code with the latest main commit
- In your terminal, `git tag YYYY.MM.DD-N` (FILLED IN!) and `git push --tags` to tag and push your CalVer tag
- Start with `N=1` for a release, incrementing if there is another release on the same day. So the first release on `2000.10.10` would be `2000.10.10-1`, ths second release on that day would be `2000.10.10-2`, etc.
- On Github.com, open the Releases page: https://github.com/HHS/simpler-grants-gov/releases
- Click "Draft a new release"
- Choose the tag you just pushed as the current tag, and the last CalVer release as the previous tag
- Click "Generate release notes" to auto-generate release notes
- Click "Publish" to finalize this step
- On Github.com, open the Actions page: https://github.com/HHS/simpler-grants-gov/actions
- You should see Actions that correspond to your release. Follow their status to ensure that they succeed. Follow-up may be required if the Github Actions fail. Here's some places where you might see Github Actions status:
- https://github.com/HHS/simpler-grants-gov/actions/workflows/cd-api.yml
- https://github.com/HHS/simpler-grants-gov/actions/workflows/cd-frontend.yml
- https://github.com/HHS/simpler-grants-gov/actions/workflows/cd-storybook.yml

## Documentation

Expand Down

0 comments on commit 04c2f9a

Please sign in to comment.