From 8e59f27a2aa3f9db567d69e08c5a187f34d90535 Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Thu, 31 Oct 2024 13:02:53 +0100 Subject: [PATCH] issue templates --- .github/ISSUE_TEMPLATE.md | 13 +++++ .github/ISSUE_TEMPLATE/bug.md | 10 ++++ .github/ISSUE_TEMPLATE/devops.md | 10 ++++ .github/ISSUE_TEMPLATE/epic.md | 13 +++++ .github/ISSUE_TEMPLATE/feature.md | 10 ++++ .github/ISSUE_TEMPLATE/question.md | 13 +++++ .github/ISSUE_TEMPLATE/refactor.md | 10 ++++ .github/ISSUE_TEMPLATE/release.md | 13 +++++ .github/PULL_REQUEST_TEMPLATE.md | 15 ++++++ .github/workflows/test.lint.pr.yml | 76 ++++++++++++++++++++++++++++++ 10 files changed, 183 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/devops.md create mode 100644 .github/ISSUE_TEMPLATE/epic.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/refactor.md create mode 100644 .github/ISSUE_TEMPLATE/release.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/test.lint.pr.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..9c617ee4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ + + + + +## 💬 Issue + + + diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 00000000..d73d32d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,10 @@ +--- +name: 🐛 Bug +about: Create a report to help us improve +labels: bug +title: 🐛 [Bug] +--- + + +## 🐛 Bug + diff --git a/.github/ISSUE_TEMPLATE/devops.md b/.github/ISSUE_TEMPLATE/devops.md new file mode 100644 index 00000000..038fcc8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/devops.md @@ -0,0 +1,10 @@ +--- +name: 💥 DevOp +about: Help us manage our deployed Software. +labels: devops +title: 💥 [DevOps] +--- + + +## 💥 DevOps + diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md new file mode 100644 index 00000000..af511e6e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -0,0 +1,13 @@ +--- +name: 🌟 Epic +about: Define a big development Step +labels: epic +title: 🌟 [EPIC] +--- + + + + + +## 🌟 EPIC + diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 00000000..27f2211d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,10 @@ +--- +name: 🚀 Feature +about: Suggest an idea for this project +labels: feature +title: 🚀 [Feature] +--- + + +## 🚀 Feature + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..b57adcd0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,13 @@ +--- +name: 💬 Question +about: If you need help understanding our Software. +labels: question +title: 💬 [Question] +--- + + + + + +## 💬 Question + diff --git a/.github/ISSUE_TEMPLATE/refactor.md b/.github/ISSUE_TEMPLATE/refactor.md new file mode 100644 index 00000000..49223c6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactor.md @@ -0,0 +1,10 @@ +--- +name: 🔧 Refactor +about: Help us improve our code by refactoring it. +labels: refactor +title: 🔧 [Refactor] +--- + + +## 🔧 Refactor + diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md new file mode 100644 index 00000000..c9f4b787 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release.md @@ -0,0 +1,13 @@ +--- +name: 🎂 Release +about: Define a Release +labels: release +title: 🎂 [RELEASE] +--- + + + + + +## 🎂 RELEASE + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..d40a2770 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ + + +## 🍰 Pullrequest + + +### Issues + +- None + +### Todo + +- [X] None diff --git a/.github/workflows/test.lint.pr.yml b/.github/workflows/test.lint.pr.yml new file mode 100644 index 00000000..7bd76dee --- /dev/null +++ b/.github/workflows/test.lint.pr.yml @@ -0,0 +1,76 @@ +name: "test:lint pull request CI" + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +permissions: + pull-requests: write + statuses: write + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + if: ${{ github.actor != 'dependabot[bot]' }} + steps: + - uses: amannn/action-semantic-pull-request@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + # Configure which types are allowed (newline delimited). + # Default: https://github.com/commitizen/conventional-commit-types + #types: | + # fix + # feat + # Configure which scopes are allowed (newline delimited). + # Append a scope for each service here + scopes: | + docu + docker + release + workflow + other + # Configure that a scope must always be provided. + requireScope: true + # Configure which scopes (newline delimited) are disallowed in PR + # titles. For instance by setting # the value below, `chore(release): + # ...` and `ci(e2e,release): ...` will be rejected. + #disallowScopes: | + # release + # Configure additional validation for the subject based on a regex. + # This example ensures the subject doesn't start with an uppercase character. + subjectPattern: ^(?![A-Z]).+$ + # If `subjectPattern` is configured, you can use this property to override + # the default error message that is shown when the pattern doesn't match. + # The variables `subject` and `title` can be used within the message. + subjectPatternError: | + The subject "{subject}" found in the pull request title "{title}" + didn't match the configured pattern. Please ensure that the subject + doesn't start with an uppercase character. + # If you use GitHub Enterprise, you can set this to the URL of your server + #githubBaseUrl: https://github.myorg.com/api/v3 + # If the PR contains one of these labels (newline delimited), the + # validation is skipped. + # If you want to rerun the validation when labels change, you might want + # to use the `labeled` and `unlabeled` event triggers in your workflow. + #ignoreLabels: | + # bot + # ignore-semantic-pull-request + # If you're using a format for the PR title that differs from the traditional Conventional + # Commits spec, you can use these options to customize the parsing of the type, scope and + # subject. The `headerPattern` should contain a regex where the capturing groups in parentheses + # correspond to the parts listed in `headerPatternCorrespondence`. + # See: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#headerpattern + headerPattern: '^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$' + headerPatternCorrespondence: type, scope, subject + # For work-in-progress PRs you can typically use draft pull requests + # from GitHub. However, private repositories on the free plan don't have + # this option and therefore this action allows you to opt-in to using the + # special "[WIP]" prefix to indicate this state. This will avoid the + # validation of the PR title and the pull request checks remain pending. + # Note that a second check will be reported if this is enabled. + wip: true \ No newline at end of file