From e6f079c644490a20df08d3a5aad518ad3e472755 Mon Sep 17 00:00:00 2001 From: vc1492a Date: Wed, 4 Sep 2024 16:09:56 -0700 Subject: [PATCH 1/2] add release please action yml --- .github/workflows/release-please.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/release-please.yml diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml new file mode 100644 index 0000000..298f0fc --- /dev/null +++ b/.github/workflows/release-please.yml @@ -0,0 +1,24 @@ +on: + push: + branches: + - main # release branch (default) + +permissions: + contents: write + pull-requests: write + +name: release-please + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + - uses: googleapis/release-please-action@v4 + with: + # this assumes that you have created a personal access token + # (PAT) and configured it as a GitHub action secret named + # `RELEASE_PLEASE_PERSONAL_ACCESS_TOKEN` (this secret name is not important). + token: ${{ secrets.RELEASE_PLEASE_PERSONAL_ACCESS_TOKEN }} + # this is a built-in strategy in release-please, see "Action Inputs" + # for more options + release-type: simple \ No newline at end of file From 0f69a6784654e2cd9fd56a1ae4f36769ac182cc3 Mon Sep 17 00:00:00 2001 From: vc1492a Date: Wed, 4 Sep 2024 16:12:46 -0700 Subject: [PATCH 2/2] add conventinal commits documentation in readme.md --- readme.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 77b1724..d595187 100644 --- a/readme.md +++ b/readme.md @@ -401,10 +401,15 @@ any changes to a branch which corresponds to an open issue. Hot fixes and bug fixes can be represented by branches with the prefix `fix/` versus `feature/` for new capabilities or code improvements. Pull requests will then be made from these branches into the repository's `dev` branch -prior to being pulled into `main`. Pull requests which are works in -progress or ready for merging should be indicated by their respective -prefixes ([WIP] and [MRG]). Pull requests with the [MRG] prefix will be -reviewed prior to being pulled into the `main` branch. +prior to being pulled into `main`. + +### Commit Messages and Releases + +**Your commit messages are important** - here's why. + +PyNomaly leverages [release-please](https://github.com/googleapis/release-please-action) to help automate the release process using the [Conventional Commits](https://www.conventionalcommits.org/) specification. When pull requests are opened to the `main` branch, release-please will collate the git commit messages and prepare an organized changelog and release notes. This process can be completed because of the Conventional Commits specification. + +Conventional Commits provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can check out examples [here](https://www.conventionalcommits.org/en/v1.0.0/#examples). Make a best effort to use the specification when contributing to Infactory code as it dramatically eases the documentation around releases and their features, breaking changes, bug fixes and documentation updates. ### Tests When contributing, please ensure to run unit tests and add additional tests as