From 4727dfa33b520c829450d6f9fc02253365837009 Mon Sep 17 00:00:00 2001 From: Kev Date: Tue, 19 Nov 2024 18:22:24 -0500 Subject: [PATCH 1/6] Allow dependabot to update GitHub actions --- .github/dependabot.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f8cbdfa..e7ca1fc 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -14,4 +14,20 @@ updates: 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 + + - 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 From 53f5d67108a25d4fd4c7757f646c8dcb6683f873 Mon Sep 17 00:00:00 2001 From: Kev Date: Tue, 19 Nov 2024 18:23:40 -0500 Subject: [PATCH 2/6] Python group minor updates and patches --- .github/dependabot.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e7ca1fc..3f4e6fe 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,11 +7,6 @@ version: 2 updates: - package-ecosystem: "pip" # See documentation for possible values directory: "/" # Location of package manifests - schedule: - interval: "weekly" - open-pull-requests-limit: 100 - - package-ecosystem: "github-actions" - directory: "/" schedule: interval: "weekly" groups: @@ -20,7 +15,6 @@ updates: - "minor" # an array, possible values being minor, patch and major - "patch" open-pull-requests-limit: 100 - - package-ecosystem: "github-actions" directory: "/" schedule: From 57cb312f3cd3b4a0fe3c336615d32342ea7a5b70 Mon Sep 17 00:00:00 2001 From: Kev Date: Tue, 19 Nov 2024 18:30:38 -0500 Subject: [PATCH 3/6] Update CodeQL checkout version --- .github/workflows/codeql.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index ffcc12a..1a0f633 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -48,7 +48,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4 + uses: actions/checkout@v4.1.1 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL From 85d2a00e5928f9c56b5844ede2a6bfb9e90d74d4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 19 Nov 2024 23:32:34 +0000 Subject: [PATCH 4/6] Bump actions/checkout in the non-major-versions group Bumps the non-major-versions group with 1 update: [actions/checkout](https://github.com/actions/checkout). Updates `actions/checkout` from 4.1.1 to 4.2.2 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.1.1...v4.2.2) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor dependency-group: non-major-versions ... Signed-off-by: dependabot[bot] --- .github/workflows/codeql.yml | 2 +- .github/workflows/lint.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 1a0f633..5afc147 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -48,7 +48,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4.1.1 + uses: actions/checkout@v4.2.2 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 465fa9b..65d49c1 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.1.1" + uses: "actions/checkout@v4.2.2" - name: "Set up Python" uses: actions/setup-python@v5.3.0 From f8e66cfb3f73a65e2a7e340d8653613ec55d616d Mon Sep 17 00:00:00 2001 From: Kev Date: Tue, 19 Nov 2024 18:44:15 -0500 Subject: [PATCH 5/6] Add issue/pr templates (#20) --- .github/ISSUE_TEMPLATE/bug.yml | 64 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 +++++++ .github/ISSUE_TEMPLATE/general.yml | 23 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++ 4 files changed, 116 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/general.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md 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/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 From 9867151491cbbe875cb0415efa21841e77a52280 Mon Sep 17 00:00:00 2001 From: Kev Date: Wed, 20 Nov 2024 12:11:18 -0500 Subject: [PATCH 6/6] Add documentation as an issue template --- .github/ISSUE_TEMPLATE/documentation.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml 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