diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..c9b0613 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,64 @@ +name: Bug Report +description: Report an issue with the code. +labels: ["bug" , "Needs Review"] +body: + + - type: textarea + id: describe-the-bug + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is and how to repoduce it. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: | + Example: + "This happened..." + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: Explain what actually happens. + placeholder: | + Example: + "This happened instead..." + validations: + required: true + + - type: textarea + id: os-details + attributes: + label: Operating System Information + validations: + required: true + + - type: textarea + id: log-info + attributes: + label: Log Output + description: Include any log output within the code blocks. + value: | + ``` + + ``` + + - type: checkboxes + id: acknowledgements + attributes: + label: Troubleshooting steps + description: Before reporting an issue follow these troubleshooting steps to see if it solves the issue. + options: + - label: This issue is related to the self-hosting code and not an API issue. + required: true + - label: I have read through the [README](https://github.com/Pirate-Weather/pirate-weather-code/blob/main/README.md) before opening this issue. + required: true + - label: I have written an informative title. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..550c754 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Questions + url: https://github.com/Pirate-Weather/pirate-weather-code/discussions + about: Please ask and answer questions here. + - name: API Repository + url: https://github.com/Pirate-Weather/pirateweather/ + about: Report issues with and request features to the API here. + - name: Home Assistant Repository + url: https://github.com/Pirate-Weather/pirate-weather-ha + about: Please report any issues with the Home Assistant integration here. + - name: Translations Repository + url: https://github.com/Pirate-Weather/translations + about: Please report any issues with the translations used in the API here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..f59aab0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,23 @@ +name: Documentation +description: Report an issue with the self-hosting documentation. +labels: ["documentation", "Needs Review"] +body: + + - type: textarea + id: describe-the-issue + attributes: + label: Describe the issue + validations: + required: true + + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + options: + - label: This issue is related to the self-hosting code and not an API issue. + required: true + - label: I have read through the [README](https://github.com/Pirate-Weather/pirate-weather-code/blob/main/README.md) before opening this issue. + required: true + - label: I have written an informative title. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml new file mode 100644 index 0000000..8716041 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -0,0 +1,23 @@ +name: General Issue +description: Report an issue which doesn't fit in with any of the other categories. +labels: ["Needs Review"] +body: + + - type: textarea + id: describe-the-issue + attributes: + label: Describe the issue + validations: + required: true + + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + options: + - label: This issue is related to the self-hosting code and not an API issue. + required: true + - label: I have read through the [README](https://github.com/Pirate-Weather/pirate-weather-code/blob/main/README.md) before opening this issue. + required: true + - label: I have written an informative title. + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..2737399 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +## Describe the change + +## Type of change + +- [ ] Bugfixes to existing code +- [ ] Breaking change +- [ ] Code quality improvements to existing code or addition of tests +- [ ] Documentation Updates + +## Checklist + +- This pull request fixes issue: fixes # +- [ ] Code builds locally. **Your pull request won't be merged unless tests pass** +- [ ] Code has been formatted using ruff +- [ ] I have signed the CLA agreement \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f8cbdfa..3f4e6fe 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,9 +9,19 @@ updates: directory: "/" # Location of package manifests schedule: interval: "weekly" + groups: + non-major-versions: # the name of the group + update-types: # the key used to specify the semver level to include in the group + - "minor" # an array, possible values being minor, patch and major + - "patch" open-pull-requests-limit: 100 - package-ecosystem: "github-actions" directory: "/" schedule: interval: "weekly" + groups: + non-major-versions: # the name of the group + update-types: # the key used to specify the semver level to include in the group + - "minor" # an array, possible values being minor, patch and major + - "patch" open-pull-requests-limit: 100 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 739a564..a58bb68 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -13,7 +13,7 @@ jobs: runs-on: "ubuntu-latest" steps: - name: "Checkout the repository" - uses: "actions/checkout@v4.2.2" # v4.2.2 + uses: "actions/checkout@v4.2.2" - name: "Set up Python" uses: actions/setup-python@v5.3.0 @@ -32,6 +32,6 @@ jobs: run: ruff check --output-format=github . --fix --exit-zero - name: "Auto Commit" - uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1 + uses: stefanzweifel/git-auto-commit-action@5.0.1 with: commit_message: 'style fixes by ruff'