Skip to content

Commit

Permalink
Merge pull request #62 from vc1492a/feature/release-please
Browse files Browse the repository at this point in the history
Feature/release-please
  • Loading branch information
vc1492a committed Sep 17, 2024
2 parents 0fd6f33 + 0f69a67 commit 63e7c8a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 4 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -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
13 changes: 9 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 63e7c8a

Please sign in to comment.