From 586275ae4aa2491e379678bed6f533adbe76bac3 Mon Sep 17 00:00:00 2001 From: Jakub Bednar Date: Thu, 18 May 2023 14:15:25 +0200 Subject: [PATCH] feat: GitHub Config --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 54 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml | 37 +++++++++++++++ .github/ISSUE_TEMPLATE/SUPPORT.yml | 17 +++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++ .github/dependabot.yml | 6 +++ .github/workflows/codeql-analysis.yml | 31 +++++++++++++ .github/workflows/linter.yml | 36 +++++++++++++++ .github/workflows/semantic.yml | 14 ++++++ .markdownlint.yml | 7 +++ 9 files changed, 218 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/SUPPORT.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/codeql-analysis.yml create mode 100644 .github/workflows/linter.yml create mode 100644 .github/workflows/semantic.yml create mode 100644 .markdownlint.yml diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 0000000..5f081b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,54 @@ +name: Bug Report +description: Create a bug report to help us improve +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking time to fill out this bug report! We reserve this repository issues for bugs with reproducible problems. + Please redirect any questions about the client usage to our [Community Slack](https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA) or [Community Page](https://community.influxdata.com/) we have a lot of talented community members there who could help answer your question more quickly. + + * Please add a :+1: or comment on a similar existing bug report instead of opening a new one. + * Please check whether the bug can be reproduced with the latest release. + - type: textarea + id: specifications + attributes: + label: Specifications + description: Describe the steps to reproduce the bug. + value: | + * Client Version: + * InfluxDB Version: + * Platform: + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Code sample to reproduce problem + description: Provide a code sample that reproduces the problem + value: | + ```csharp + ``` + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: Describe what you expected to happen when you performed the above steps. + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: Describe what actually happened when you performed the above steps. + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional info + description: Include gist of relevant config, logs, etc. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml new file mode 100644 index 0000000..415f541 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml @@ -0,0 +1,37 @@ +name: Feature request +description: Create a feature request to make client more awesome +labels: ["feature request"] +body: + - type: markdown + attributes: + value: | + Thanks for taking time to share with us this feature request! Please describe why you would like this feature to be added to the client, how you plan to use it to make your life better. + - type: textarea + id: use-case + attributes: + label: Use Case + description: Describe how you plan to use this feature. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: Describe what you expected to happen when you performed the above steps. + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: Describe what actually happened when you performed the above steps. + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional info + description: Include gist of relevant config, logs, etc. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.yml b/.github/ISSUE_TEMPLATE/SUPPORT.yml new file mode 100644 index 0000000..ca228bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/SUPPORT.yml @@ -0,0 +1,17 @@ +name: Support request +description: Open a support request +labels: ["support"] +body: + - type: markdown + attributes: + value: | + WOAHH, hold up. This isn't the best place for support questions. + You can get a faster response on slack or forums: + + Please redirect any QUESTIONS about Telegraf usage to + - InfluxData Slack Channel: https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA + - InfluxData Community Site: https://community.influxdata.com + + - type: textarea + attributes: + label: "Please direct all support questions to slack or the forums. Thank you." diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..aafe710 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +Closes # + +## Proposed Changes + +_Briefly describe your proposed changes:_ + +## Checklist + + + +- [ ] CHANGELOG.md updated +- [ ] Rebased/mergeable +- [ ] A test has been added if appropriate +- [ ] Tests pass +- [ ] Commit messages are [conventional](https://www.conventionalcommits.org/en/v1.0.0/) +- [ ] Sign [CLA](https://www.influxdata.com/legal/cla/) (if not already signed) diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..04ceb6e --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "maven" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..d470e5e --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,31 @@ +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + CodeQL-Build: + runs-on: ubuntu-latest + + permissions: + security-events: write + actions: read + contents: read + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: java + + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml new file mode 100644 index 0000000..df1760e --- /dev/null +++ b/.github/workflows/linter.yml @@ -0,0 +1,36 @@ +name: "Lint Code Base" + +on: + push: + branches-ignore: [main] + pull_request: + branches: [main] + +jobs: + build: + permissions: + contents: read + packages: read + statuses: write + + name: Lint Code Base + runs-on: ubuntu-latest + + steps: + - name: Checkout Code + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Lint Code Base + uses: github/super-linter@v4.9.2 + env: + VALIDATE_ALL_CODEBASE: false + DEFAULT_BRANCH: main + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + LINTER_RULES_PATH: '.' + MARKDOWN_CONFIG_FILE: .markdownlint.yml + VALIDATE_MARKDOWN: true + VALIDATE_BASH: true + VALIDATE_JAVA: true + VALIDATE_GITHUB_ACTIONS: true diff --git a/.github/workflows/semantic.yml b/.github/workflows/semantic.yml new file mode 100644 index 0000000..0f9ed27 --- /dev/null +++ b/.github/workflows/semantic.yml @@ -0,0 +1,14 @@ +--- +name: "Semantic PR and Commit Messages" + +on: + pull_request: + types: [opened, reopened, synchronize, edited] + branches: + - main + +jobs: + semantic: + uses: influxdata/validate-semantic-github-messages/.github/workflows/semantic.yml@main + with: + CHECK_PR_TITLE_OR_ONE_COMMIT: true diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..ce7479e --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,7 @@ +{ + "MD013": false, + "MD033": { + "allowed_elements": [ "a", "img", "p" ] + }, + "MD041": false, +} \ No newline at end of file