close
Skip to content

Update docs with release process#42

Merged
travissouthard merged 3 commits into
developfrom
ts/update-docs
May 7, 2023
Merged

Update docs with release process#42
travissouthard merged 3 commits into
developfrom
ts/update-docs

Conversation

@travissouthard
Copy link
Copy Markdown
Collaborator

Overview

Add documentation for release process and how to create and execute releases.
Reconcile the changelog with the versions created as part of the CI implementation

Closes #41

Testing instructions

  • Read through the added documentation and ensure:
    • It makes sense with the process
    • It covers all the steps involved
    • It is not redundant

Checklist before merge

  • Update the CHANGELOG.md
  • Rebase your changes from whatever branch you're merging to

@travissouthard travissouthard merged commit 2b03df7 into develop May 7, 2023
@travissouthard travissouthard deleted the ts/update-docs branch May 7, 2023 11:52
Comment thread RELEASES.md

## Overview

Releases on this project are triggered through GitHub Actions listening for differences between our `main` and `develop` branches. A pull request for the next release is created by a github-actions bot and merging this pull request automatically delivers the changes up to production.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@travissouthard once we finish, the setup won't be that changes get delivered up to production. The result will be a new version is available, and then it's a separate PR against Code for Philly's live cluster to increase what version Code for Philly has deployed.

There is some interest in trying out what it would be like to automate that, we could give it a shot as a next step

@themightychris themightychris mentioned this pull request May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for release process

3 participants