From 6e0c9b5c2c5cb408b8ae9be936c0a7c35d7cb771 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Mon, 12 Jun 2023 23:23:55 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=84=20synced=20file(s)=20with=20klaasn?= =?UTF-8?q?icolaas/github-config=20(#374)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * ๐Ÿ”„ synced local '.gitignore' with remote 'python/.gitignore' * ๐Ÿ”„ synced local '.github/' with remote 'github/' --- .github/ISSUE_TEMPLATE/bug_report.yml | 60 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 43 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 24 +++++++++ .github/labels.yml | 23 +++++++-- .github/release-drafter.yml | 3 ++ .github/workflows/labels.yaml | 4 +- .github/workflows/pr-labels.yaml | 12 +++-- .github/workflows/release-drafter.yaml | 4 ++ .gitignore | 6 +-- 9 files changed, 167 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..6351e90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,60 @@ +--- +name: ๐Ÿž Bug Report +description: File a bug/issue +title: "" +labels: + - bug + +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false + + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false + + - type: textarea + attributes: + label: Environment + description: | + Please describe your execution environment providing as much detail as possible + render: Markdown + validations: + required: false + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..9810b85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +--- +name: ๐Ÿš€ Feature Request +description: Request a new feature or enhancement +title: "<title>" +labels: + - enhancement + - new-feature +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you want. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + attributes: + label: How would this feature be useful? + description: Describe any use cases this solves or frustrations it alleviates. + validations: + required: false + + - type: textarea + attributes: + label: Describe the solution you'd like + description: If you have an idea on how to do this, let us know here! + validations: + required: false + + - type: textarea + attributes: + label: Describe alternatives you've considered + description: If there's some workaround or alternative solutions, let us know here! + validations: + required: false + + - type: textarea + attributes: + label: Anything else? + description: Any other relevant information or background. + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ec315d0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,24 @@ +## Proposed change +<!-- + Describe the big picture of your changes here to communicate to the + maintainers why we should accept this pull request. If it fixes a bug + or resolves a feature request, be sure to link to that issue in the + additional information section. +--> + +## Additional information +<!-- + Details are important, and help maintainers processing your PR. + Please be sure to fill out additional details, if applicable. +--> + +- This PR fixes or closes issue: fixes # + +## Checklist +<!-- + Go over all the following points, and put an `x` in all the boxes that apply. + If you're unsure about any of these, don't hesitate to ask. We're here to help! +--> + +- [ ] I have updated the documentation if needed. +- [ ] I have updated the tests if needed. diff --git a/.github/labels.yml b/.github/labels.yml index 2d0f68a..60a15cd 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -1,10 +1,13 @@ --- - name: "breaking-change" - color: ee0701 + color: d93f0b description: "A breaking change for existing users." -- name: "bugfix" - color: ee0701 +- name: "bug" + color: fc2929 description: "Inconsistencies or issues which will cause a problem for users or implementors." +- name: "bugfix" + color: ededed + description: "Fixing a bug." - name: "documentation" color: 0052cc description: "Solely about the documentation of the project." @@ -19,7 +22,7 @@ description: "Improving performance, not introducing new features." - name: "new-feature" color: 0e8a16 - description: "New features or options." + description: "New features or request." - name: "maintenance" color: 2af79e description: "Generic maintenance tasks." @@ -39,6 +42,15 @@ - name: "no-stale" color: fef2c0 description: "This issue or PR is exempted from the stable bot." +- name: "wontfix" + color: ffffff + description: "This issue or PR will not be fixed." +- name: "cleanup" + color: ef75d5 + description: "Cleanup of code." +- name: "sync" + color: 00a6ed + description: "Syncing with upstream github config repository." - name: "security" color: ee0701 @@ -49,6 +61,9 @@ - name: "invalid" color: fef2c0 description: "Marks a PR or issue that is missing information." +- name: "duplicate" + color: cfd3d7 + description: "This issue or pull request already exists." - name: "beginner-friendly" color: 0e8a16 diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index cd71954..604e4c5 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -31,6 +31,9 @@ categories: labels: - "dependencies" +exclude-labels: + - "sync" + version-resolver: major: labels: diff --git a/.github/workflows/labels.yaml b/.github/workflows/labels.yaml index 48bd84e..27b449d 100644 --- a/.github/workflows/labels.yaml +++ b/.github/workflows/labels.yaml @@ -14,9 +14,11 @@ jobs: labels: name: โ™ป๏ธ Sync labels runs-on: ubuntu-latest + permissions: + pull-requests: write steps: - name: โคต๏ธ Check out code from GitHub - uses: actions/checkout@v3.3.0 + uses: actions/checkout@v3.5.3 - name: ๐Ÿš€ Run Label Syncer uses: micnncim/action-label-syncer@v1.3.0 env: diff --git a/.github/workflows/pr-labels.yaml b/.github/workflows/pr-labels.yaml index 071e6d6..7e5619b 100644 --- a/.github/workflows/pr-labels.yaml +++ b/.github/workflows/pr-labels.yaml @@ -4,20 +4,24 @@ name: PR Labels # yamllint disable-line rule:truthy on: pull_request_target: - types: [opened, labeled, unlabeled, synchronize] + types: + - opened + - labeled + - unlabeled + - synchronize + workflow_call: jobs: pr_labels: name: Verify runs-on: ubuntu-latest - if: ${{ github.actor != 'dependabot[bot]' }} steps: - name: ๐Ÿท Verify PR has a valid label uses: jesusvasquez333/verify-pr-label-action@v1.4.0 with: - github-token: "${{ secrets.GITHUB_TOKEN }}" pull-request-number: "${{ github.event.pull_request.number }}" + github-token: "${{ secrets.GITHUB_TOKEN }}" valid-labels: >- - breaking-change, bugfix, documentation, enhancement, + breaking-change, bugfix, documentation, enhancement, sync, refactor, performance, new-feature, maintenance, ci, dependencies disable-reviews: true diff --git a/.github/workflows/release-drafter.yaml b/.github/workflows/release-drafter.yaml index dc1b1fc..4f1d343 100644 --- a/.github/workflows/release-drafter.yaml +++ b/.github/workflows/release-drafter.yaml @@ -6,11 +6,15 @@ on: push: branches: - main + workflow_dispatch: jobs: update_release_draft: name: โœ๏ธ Draft release runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: read steps: - name: ๐Ÿš€ Run Release Drafter uses: release-drafter/release-drafter@v5.23.0 diff --git a/.gitignore b/.gitignore index 21ef993..e0859fb 100644 --- a/.gitignore +++ b/.gitignore @@ -117,12 +117,12 @@ venv.bak/ # mypy .mypy_cache/ -# ruff -.ruff_cache - # Visual Studio Code .vscode +# ruff +.ruff_cache + # Pyre type checker .pyre/