From e69e468f7cb1df65d816844c2cdbe8f4a5d89317 Mon Sep 17 00:00:00 2001 From: Noah Dietz Date: Fri, 18 Aug 2023 10:07:14 -0700 Subject: [PATCH] chore(ci): configure release-please, update contrib (#122) --- .github/workflows/release.yaml | 20 ++++++++++++++++++++ CHANGELOG.md | 2 ++ CONTRIBUTING.md | 16 ++++++++++++++++ 3 files changed, 38 insertions(+) create mode 100644 .github/workflows/release.yaml create mode 100644 CHANGELOG.md diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..0ca82d5 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,20 @@ +--- +name: release-please +on: + push: + branches: + - master + +permissions: + contents: write + pull-requests: write + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + - uses: google-github-actions/release-please-action@v3 + with: + release-type: go + package-name: uuid + skip-labeling: true diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4dc68c6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +# Changelog + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04fdf09..5566888 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,22 @@ We definitely welcome patches and contribution to this project! +### Tips + +Commits must be formatted according to the [Conventional Commits Specification](https://www.conventionalcommits.org). + +Always try to include a test case! If it is not possible or not necessary, +please explain why in the pull request description. + +### Releasing + +Commits that would precipitate a SemVer change, as desrcibed in the Conventional +Commits Specification, will trigger [`release-please`](https://github.com/google-github-actions/release-please-action) +to create a release candidate pull request. Once submitted, `release-please` +will create a release. + +For tips on how to work with `release-please`, see its documentation. + ### Legal requirements In order to protect both you and ourselves, you will need to sign the