Skip to content

Commit

Permalink
docs: David/update docs sem rel (#324)
Browse files Browse the repository at this point in the history
* docs: Update docs with basic info on semantic release process. Confirm that PR title needs updating when doing a squash in order to trigger release.

* docs: second commit to test

* docs: final commit to test
  • Loading branch information
recalcitrantsupplant authored Jan 13, 2025
1 parent 37bfb93 commit 6767dca
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README-Dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -736,3 +736,8 @@ Prez caches the following things using aiocache:
3. Internal links generated for items
3. Feature Collection information *at the feature listing endpoint only*. These are cached for 10 minutes only.
There is no other caching of "instance" data in Prez.


## Release Process

Semantic-release has been set up on this repository. Conventional Commit messages should be used for all commits (https://www.conventionalcommits.org/en/v1.0.0/), though it is not currently enforced with any actions etc. Releases are automatically made when PRs are merged to main, based on the commit messages. NB if squashing commits when merging a PR, the commit messages are merged, and the PR title will be included at the start of the commit message. This means the PR title needs to follow conventional commit conventions in order for the release process to be triggered.

0 comments on commit 6767dca

Please sign in to comment.