diff --git a/marklogic/CHANGELOG.md b/marklogic/CHANGELOG.md deleted file mode 100644 index 61d9fda..0000000 --- a/marklogic/CHANGELOG.md +++ /dev/null @@ -1,56 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog 1.0.0]. - -## [Unreleased] - -## [Release 1.0.7] -- condition for

s without a @style attribute - -## [Release 1.0.6] -- ADR 0009: Reading unpublished judgments and Marklogic security boundaries -- ADR 0010: Interface with Enrichment -- Use unfiltered search results -- Add KB to Neutral Citation regex in helper.xqy -- Search by consignment number -- support for new header alignment styles - -## [Release 1.0.5] -- Grant the caselaw-writer role the ability to view unpublished documents -- Script to create python server (fastapi) -- Privileged API spec improvement -- Add VPN related documentation -- Create failover replicas for the caselaw-content databases -- Rename judgment0.xsl and judgment2.xsl to have more descriptive names - -## [Release 1.0.4] -- changes for upcoming parser release: subparagraphs -- Add a new privilege and role allowing users to view unpublished documents - -## [Release 1.0.3] -- Document FRBRdate discussion as an ADR -- remove inline fonts (except Symbol) -- remove

s -- Deprecate loading data locally from S3 - -## [Release 1.0.2] -- use , and elements - -## [Release 1.0.1] -- Re-enable non-websafe images in the XSLT transformations - -## [Release 1.0.0] -- Initial tagged release -- Add transformation sort order for search - -[Unreleased]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.7...HEAD -[Release 1.0.7]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.7...v1.0.6 -[Release 1.0.6]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.6...v1.0.5 -[Release 1.0.5]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.5...v1.0.4 -[Release 1.0.4]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.4...v1.0.3 -[Release 1.0.3]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.2...v1.0.3 -[Release 1.0.2]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.1...v1.0.2 -[Release 1.0.1]: https://github.com/nationalarchives/ds-caselaw-public-access-service/compare/v1.0.0...v1.0.1 -- [keep a changelog 1.0.0]: https://keepachangelog.com/en/1.0.0/ diff --git a/marklogic/README.md b/marklogic/README.md index bd7ee78..c8c1473 100644 --- a/marklogic/README.md +++ b/marklogic/README.md @@ -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.