Skip to content

Commit

Permalink
Merge pull request #87 from nationalarchives/chore/update-release-pro…
Browse files Browse the repository at this point in the history
…cess-to-use-github

Update the README to show we can use Github's release process
  • Loading branch information
Laura Porter authored Oct 4, 2022
2 parents 6e5ef47 + 808e7ca commit d54c003
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 70 deletions.
56 changes: 0 additions & 56 deletions marklogic/CHANGELOG.md

This file was deleted.

20 changes: 6 additions & 14 deletions marklogic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,16 @@ A `docker-compose.yml` file for running Marklogic locally is included. Run `dock

## Release versioning

The releases are currently manually tagged. Please do not deploy to production without tagging a release.
The releases are currently manually tagged. Please do not deploy to production without tagging a release. Currently
there is no auto-deployment of releases, but we are using releases & tags to keep track of what has been deployed to
production.

When making a new release version, update the [changelog](CHANGELOG.md) in the release
pull request.

To create a versioned release:

1. Create a branch `release/v{major}.{minor}.{patch}`
2. Update changelog for the release
3. Commit and push
4. Open a PR from that branch to main
5. Get approval on the PR
6. Tag the HEAD of the PR `v{major}.{minor}.{patch}` and push the tag
7. Merge the PR to main and push
To create a versioned release, use Github's [release pricess](https://github.com/nationalarchives/ds-caselaw-public-access-service/releases)
to create a tag and generate release notes.

When deploying to production, check out the tag you want to deploy using (for example) `git checkout tags/v1.0.0`
then deploy from there. Git will put you into a "detatched head" state, and once you have finished deploying you can
switch back to the main branch (or any branch) but using `git checkout branchname` as normal.
switch back to the main branch (or any branch) by using `git checkout branchname` as normal.

TODO: Automatically deploy main to staging, and tags to production using CodeBuild.

Expand Down

0 comments on commit d54c003

Please sign in to comment.