From a9b6d793344870ba53f3f6e668902e9c465fa7e9 Mon Sep 17 00:00:00 2001 From: Bryan Phelps Date: Wed, 5 Jan 2022 03:47:23 +0000 Subject: [PATCH 1/4] chore: Add semantic pull requests --- .github/semantic.yaml | 74 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 .github/semantic.yaml diff --git a/.github/semantic.yaml b/.github/semantic.yaml new file mode 100644 index 0000000000000..91d20f616501a --- /dev/null +++ b/.github/semantic.yaml @@ -0,0 +1,74 @@ +############################################################################### +# This file configures "Semantic Pull Requests", which is documented here: +# https://github.com/zeke/semantic-pull-requests +# +# This action/spec implements the "Conventional Commits" RFC which is +# available here: +# https://www.notion.so/coderhq/Conventional-commits-1d51287f58b64026bb29393f277734ed +############################################################################### + +# Scopes are optionally supplied after a 'type'. For example, in +# +# feat(cdr): autostart ui +# +# '(cdr)' is the scope. Scopes are used to signify where the change occurred. +scopes: + # The Coder product (front/back/deploy) (path: product/coder) + - cdr + + # The Coder CLI (path: product/coder/service/cli) + - cli + + # The Coder product e2e suite (path: product/coder/e2e) + - e2e + + # A change to a shared library module (path: lib/) + - lib + +# We only check that the PR title is semantic. The PR title is automatically +# applied to the "Squash & Merge" flow as the suggested commit message, so this +# should suffice unless someone drastically alters the message in that flow. +titleOnly: true + +# Types are the 'tag' types in a commit or PR title. For example, in +# +# chore: fix thing +# +# 'chore' is the type. +types: + # A build of any kind. + - build + + # A RELEASED fix that will NOT be back-ported. The originating issue may have + # been discovered internally or externally to Coder. + - fix + + # Any code task that is ignored for changelog purposes. Examples include + # devbin scripts and internal-only configurations. + - chore + + # Any work performed on CI. + - ci + + # An UNRELEASED correction. For example, features are often built + # incrementally and sometimes introduce minor flaws during a release cycle. + # Corrections address those increments and flaws. + - correct + + # Work that directly implements or supports the implementation of a feature. + - feat + + # A fix for a RELEASED bug (regression fix) that is intended for patch-release + # purposes. + - hotfix + + # A refactor changes code structure without any behavioral change. + - refactor + + # A git revert for any style of commit. + - revert + + # Adding tests of any kind. Should be separate from feature or fix + # implementations. For example, if a commit adds a fix + test, it's a fix + # commit. If a commit is simply bumping coverage, it's a test commit. + - test From 5c10e52a9d39c2a2f5742aa8bc5570d1fbbe53a2 Mon Sep 17 00:00:00 2001 From: Bryan Phelps Date: Wed, 5 Jan 2022 03:49:46 +0000 Subject: [PATCH 2/4] bump From 82d657029639e398e4a4f0d4ad8145c7acd1d63e Mon Sep 17 00:00:00 2001 From: Bryan Phelps Date: Thu, 6 Jan 2022 20:45:00 +0000 Subject: [PATCH 3/4] Remove scopes --- .github/semantic.yaml | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/.github/semantic.yaml b/.github/semantic.yaml index 91d20f616501a..73a55f27ab449 100644 --- a/.github/semantic.yaml +++ b/.github/semantic.yaml @@ -7,24 +7,6 @@ # https://www.notion.so/coderhq/Conventional-commits-1d51287f58b64026bb29393f277734ed ############################################################################### -# Scopes are optionally supplied after a 'type'. For example, in -# -# feat(cdr): autostart ui -# -# '(cdr)' is the scope. Scopes are used to signify where the change occurred. -scopes: - # The Coder product (front/back/deploy) (path: product/coder) - - cdr - - # The Coder CLI (path: product/coder/service/cli) - - cli - - # The Coder product e2e suite (path: product/coder/e2e) - - e2e - - # A change to a shared library module (path: lib/) - - lib - # We only check that the PR title is semantic. The PR title is automatically # applied to the "Squash & Merge" flow as the suggested commit message, so this # should suffice unless someone drastically alters the message in that flow. From b3a09bafaed52babea73f544c3637707053761e7 Mon Sep 17 00:00:00 2001 From: Bryan Phelps Date: Thu, 6 Jan 2022 20:46:37 +0000 Subject: [PATCH 4/4] Add reference in README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index be1a04b98f3a9..e5efcd0897f8d 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,4 @@ This repository contains source code for Coder V2. Additional documentation: ## Directory Structure - `.github/`: Settings for [Dependabot for updating dependencies](https://docs.github.com/en/code-security/supply-chain-security/customizing-dependency-updates) and [build/deploy pipelines with GitHub Actions](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions). + - [`semantic.yaml`](./github/semantic.yaml): Configuration for [semantic pull requests](https://github.com/apps/semantic-pull-requests)