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: ""
+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
+
+
+## Additional information
+
+
+- This PR fixes or closes issue: fixes #
+
+## Checklist
+
+
+- [ ] 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 2ff3cf1..60a15cd 100644
--- a/.github/labels.yml
+++ b/.github/labels.yml
@@ -1,12 +1,13 @@
---
- name: "breaking-change"
- color: ee0701
+ color: d93f0b
description: "A breaking change for existing users."
+- name: "bug"
+ color: fc2929
+ description: "Inconsistencies or issues which will cause a problem for users or implementors."
- name: "bugfix"
- color: ee0701
- description:
- "Inconsistencies or issues which will cause a problem for users or
- implementors."
+ color: ededed
+ description: "Fixing a bug."
- name: "documentation"
color: 0052cc
description: "Solely about the documentation of the project."
@@ -21,24 +22,35 @@
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."
- name: "ci"
color: 1d76db
description: "Work that improves the continue integration."
+- name: "dependencies"
+ color: 1d76db
+ description: "Upgrade or downgrade of project dependencies."
- name: "in-progress"
color: fbca04
description: "Issue is currently being resolved by a developer."
- name: "stale"
color: fef2c0
- description:
- "There has not been activity on this issue or PR for quite some time."
+ description: "There has not been activity on this issue or PR for quite some time."
- 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,15 +61,16 @@
- 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
- description:
- "Good first issue for people wanting to contribute to the project."
+ description: "Good first issue for people wanting to contribute to the project."
- name: "help-wanted"
color: 0e8a16
- description:
- "We need some extra helping hands or expertise in order to resolve this."
+ description: "We need some extra helping hands or expertise in order to resolve this."
- name: "hacktoberfest"
description: "Issues/PRs are participating in the Hacktoberfest."
@@ -68,17 +81,20 @@
- name: "priority-critical"
color: ee0701
- description:
- "This should be dealt with ASAP. Not fixing this issue would be a serious
- error."
+ description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
- name: "priority-high"
color: b60205
- description:
- "After critical issues are fixed, these should be dealt with before any
- further issues."
+ description: "After critical issues are fixed, these should be dealt with before any further issues."
- name: "priority-medium"
color: 0e8a16
description: "This issue may be useful, and needs some attention."
- name: "priority-low"
color: e4ea8a
description: "Nice addition, maybe... someday..."
+
+- name: "major"
+ color: b60205
+ description: "This PR causes a major version bump in the version number."
+- name: "minor"
+ color: 0e8a16
+ description: "This PR causes a minor version bump in the version number."
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
index ec40e0e..604e4c5 100644
--- a/.github/release-drafter.yml
+++ b/.github/release-drafter.yml
@@ -27,10 +27,13 @@ categories:
labels:
- "documentation"
- title: "โฌ๏ธ Dependency updates"
- collapse-after: 10
+ collapse-after: 5
labels:
- "dependencies"
+exclude-labels:
+ - "sync"
+
version-resolver:
major:
labels:
diff --git a/.github/workflows/labels.yaml b/.github/workflows/labels.yaml
index aff675b..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
+ 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