From 2afe2fce60b15901230c31f68854c54919611799 Mon Sep 17 00:00:00 2001 From: Alex B <45384811+AB-xdev@users.noreply.github.com> Date: Mon, 6 May 2024 16:35:52 +0200 Subject: [PATCH 01/10] Update CONTRIBUTING.md Add note about (stealthy) Sonarlint telemetry --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d241a28..71adf87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,7 @@ You should have the following things installed: * Install the following plugins: * [Save Actions](https://plugins.jetbrains.com/plugin/22113) - Provides save actions, like running the formatter or adding ``final`` to fields * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis + * You may consider disabling telemetry in the settings under ``Tools > Sonarlint -> About`` * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis * Import the project * Ensure that everything is encoded in ``UTF-8`` From 451d36f3e2427c999d371ab07438ccb1ccd738d4 Mon Sep 17 00:00:00 2001 From: XDEV Renovate Bot Date: Thu, 9 May 2024 02:20:36 +0000 Subject: [PATCH 02/10] Update dependency org.apache.maven.plugins:maven-site-plugin to v4.0.0-M14 --- template-placeholder/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template-placeholder/pom.xml b/template-placeholder/pom.xml index 881534d..0bf57cb 100644 --- a/template-placeholder/pom.xml +++ b/template-placeholder/pom.xml @@ -90,7 +90,7 @@ org.apache.maven.plugins maven-site-plugin - 4.0.0-M13 + 4.0.0-M14 org.apache.maven.plugins From 5a2a8da2c515f0ceb7c0c66d8f95c0049bf35c45 Mon Sep 17 00:00:00 2001 From: XDEV Renovate Bot Date: Sun, 12 May 2024 02:22:20 +0000 Subject: [PATCH 03/10] Update dependency com.mycila:license-maven-plugin to v4.5 --- template-placeholder/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template-placeholder/pom.xml b/template-placeholder/pom.xml index 881534d..3b07391 100644 --- a/template-placeholder/pom.xml +++ b/template-placeholder/pom.xml @@ -103,7 +103,7 @@ com.mycila license-maven-plugin - 4.3 + 4.5 ${project.organization.url} From 0effe0a8a8e89c35d0c533440977bf62993a8cec Mon Sep 17 00:00:00 2001 From: AB Date: Mon, 13 May 2024 13:37:44 +0200 Subject: [PATCH 04/10] Create issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 68 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 +++ .github/ISSUE_TEMPLATE/enhancement.yml | 32 ++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 31 ++++++++++++ 4 files changed, 138 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..68299d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,68 @@ +name: 🐞 Bug +description: Create a bug report for something that is broken +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thank you for reporting a bug. + + Please fill in as much information as possible about your bug so that we don't have to play "information ping-pong" and can help you immediately. + + - type: checkboxes + id: checklist + attributes: + label: "Checklist" + options: + - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)" + required: true + - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to." + required: true + - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise." + required: true + - label: "This issue contains only one bug." + required: true + + - type: input + id: app-version + attributes: + label: Affected version + description: "In which version did you encounter the bug?" + placeholder: "x.x.x" + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce the bug + description: | + What did you do for the bug to show up? + + If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug. + placeholder: | + 1. Use '...' + 2. Do '...' + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: | + Tell us what you expect to happen. + + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: | + Tell us what happens with the steps given above. + + - type: textarea + id: additional-information + attributes: + label: Additional information + description: | + Any other relevant information you'd like to include diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..302a7c1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +contact_links: + - name: 💬 Contact support + url: https://xdev.software/en/services/support + about: "If you need support as soon as possible or/and you can't wait for any pull request" + - name: 🐱‍💻 Security vulnerability + url: https://github.com/xdev-software/template-placeholder/security/advisories/new + about: "If you found a security vulnerability report it here" diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 0000000..7523129 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,32 @@ +name: ✨ Feature/Enhancement +description: Suggest a new feature or enhancement +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thank you for suggesting a new feature/enhancement. + + - type: checkboxes + id: checklist + attributes: + label: "Checklist" + options: + - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to." + required: true + - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise." + required: true + - label: "This issue contains only one feature request/enhancement." + required: true + + - type: textarea + id: description + attributes: + label: Description + validations: + required: true + + - type: textarea + id: additional-information + attributes: + label: Additional information diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..6ecd6ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,31 @@ +name: ❓ Question +description: Ask a question +labels: [question] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this form! + + - type: checkboxes + id: checklist + attributes: + label: "Checklist" + options: + - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to." + required: true + - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise." + required: true + + - type: textarea + id: what-is-the-question + attributes: + label: What is/are your question(s)? + validations: + required: true + + - type: textarea + id: additional-information + attributes: + label: Additional information + description: "Any other information you'd like to include - for instance logs, screenshots, etc." From ab0a8d2cb906f5ad6b4a702f29ae2829349ad157 Mon Sep 17 00:00:00 2001 From: AB Date: Mon, 13 May 2024 13:38:00 +0200 Subject: [PATCH 05/10] Create issue labels automatically --- .github/labels.yml | 35 +++++++++++++++++++++++++++++++ .github/workflows/sync-labels.yml | 24 +++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 .github/labels.yml create mode 100644 .github/workflows/sync-labels.yml diff --git a/.github/labels.yml b/.github/labels.yml new file mode 100644 index 0000000..3679ae5 --- /dev/null +++ b/.github/labels.yml @@ -0,0 +1,35 @@ +# Default +## Required for template +- name: bug + description: "Something isn't working" + color: 'd73a4a' +- name: enhancement + description: New feature or request + color: '#a2eeef' +- name: question + description: Information is requested + color: '#d876e3' +## Others +- name: duplicate + description: This already exists + color: '#cfd3d7' +- name: good first issue + description: Good for newcomers + color: '#7057ff' +- name: help wanted + description: Extra attention is needed + color: '#008672' +- name: invalid + description: "This doesn't seem right" + color: '#e4e669' +# Custom +- name: "can't reproduce" + color: '#e95f2c' +- name: customer-requested + description: was requested by a customer of us + color: '#068374' +- name: stale + color: '#ededed' +- name: waiting-for-response + description: If no response is received after a certain time the issue will be closed + color: '#202020' diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml new file mode 100644 index 0000000..ff880f0 --- /dev/null +++ b/.github/workflows/sync-labels.yml @@ -0,0 +1,24 @@ +name: Sync labels + +on: + push: + branches: develop + paths: + - .github/labels.yml + + workflow_dispatch: + +permissions: + issues: write + +jobs: + labels: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + sparse-checkout: .github/labels.yml + + - uses: EndBug/label-sync@v2 + with: + config-file: .github/labels.yml From 209777d67ea68277111923ae002b8d3e2ccec26a Mon Sep 17 00:00:00 2001 From: Alex B <45384811+AB-xdev@users.noreply.github.com> Date: Mon, 13 May 2024 13:43:47 +0200 Subject: [PATCH 06/10] Security vulnerabilities are automatically added by GitHub --- .github/ISSUE_TEMPLATE/config.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 302a7c1..b6fb79b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,6 +2,3 @@ contact_links: - name: 💬 Contact support url: https://xdev.software/en/services/support about: "If you need support as soon as possible or/and you can't wait for any pull request" - - name: 🐱‍💻 Security vulnerability - url: https://github.com/xdev-software/template-placeholder/security/advisories/new - about: "If you found a security vulnerability report it here" From 0c0f9f17f5a34e61f9aecf47339d30df45af878e Mon Sep 17 00:00:00 2001 From: AB Date: Mon, 13 May 2024 14:44:44 +0200 Subject: [PATCH 07/10] Add search and report for broken links --- .github/labels.yml | 5 +++- .github/workflows/broken-links.yml | 41 ++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/broken-links.yml diff --git a/.github/labels.yml b/.github/labels.yml index 3679ae5..1c09985 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -23,10 +23,13 @@ description: "This doesn't seem right" color: '#e4e669' # Custom +- name: automated + description: Created by a 🤖 + color: '#000000' - name: "can't reproduce" color: '#e95f2c' - name: customer-requested - description: was requested by a customer of us + description: Was requested by a customer of us color: '#068374' - name: stale color: '#ededed' diff --git a/.github/workflows/broken-links.yml b/.github/workflows/broken-links.yml new file mode 100644 index 0000000..9b57bd4 --- /dev/null +++ b/.github/workflows/broken-links.yml @@ -0,0 +1,41 @@ +name: Broken links + +on: + workflow_dispatch: + schedule: + - cron: "23 23 * * 0" + +permissions: + issues: write + +jobs: + link-checker: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Link Checker + id: lychee + uses: lycheeverse/lychee-action@v1 + + - name: Find already existing issue + id: find-issue + run: | + echo "number=$(gh issue list -l 'bug' -l 'automated' -L 1 -S 'in:title \"Link Checker Report\"' -s 'open' --json 'number' --jq '.[].number')" >> $GITHUB_OUTPUT + env: + GH_TOKEN: ${{ github.token }} + + - name: Close issue if everything is fine + if: env.lychee_exit_code == 0 && steps.find-issue.outputs.number != '' + run: gh issue close -r 'not planned' ${{ steps.find-issue.outputs.number }} + env: + GH_TOKEN: ${{ github.token }} + + - name: Create Issue From File + if: env.lychee_exit_code != 0 + uses: peter-evans/create-issue-from-file@v5 + with: + issue-number: ${{ steps.find-issue.outputs.number }} + title: Link Checker Report + content-filepath: ./lychee/out.md + labels: bug, automated From 89be6d9cfbee3960fcd4d1e197bdffd22efe8913 Mon Sep 17 00:00:00 2001 From: AB Date: Mon, 13 May 2024 14:55:34 +0200 Subject: [PATCH 08/10] Fix "we can't handle unicode" problems --- .github/labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/labels.yml b/.github/labels.yml index 1c09985..325f4ce 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -24,7 +24,7 @@ color: '#e4e669' # Custom - name: automated - description: Created by a 🤖 + description: Created by an automation color: '#000000' - name: "can't reproduce" color: '#e95f2c' From 117e21e14048d60504cc64b9ce4422741398a8a4 Mon Sep 17 00:00:00 2001 From: AB Date: Mon, 13 May 2024 15:21:41 +0200 Subject: [PATCH 09/10] Add ignore file --- .github/.lycheeignore | 2 ++ .github/workflows/broken-links.yml | 2 ++ 2 files changed, 4 insertions(+) create mode 100644 .github/.lycheeignore diff --git a/.github/.lycheeignore b/.github/.lycheeignore new file mode 100644 index 0000000..972ca61 --- /dev/null +++ b/.github/.lycheeignore @@ -0,0 +1,2 @@ +# Ignorefile for broken link check +localhost diff --git a/.github/workflows/broken-links.yml b/.github/workflows/broken-links.yml index 9b57bd4..96af798 100644 --- a/.github/workflows/broken-links.yml +++ b/.github/workflows/broken-links.yml @@ -14,6 +14,8 @@ jobs: steps: - uses: actions/checkout@v4 + - run: mv .github/.lycheeignore .lycheeignore + - name: Link Checker id: lychee uses: lycheeverse/lychee-action@v1 From 8dbbdf91ff9f49dadba0277b776d3f79d6600ce1 Mon Sep 17 00:00:00 2001 From: AB Date: Mon, 13 May 2024 15:22:53 +0200 Subject: [PATCH 10/10] Ignore non resolveable links --- .github/.lycheeignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/.lycheeignore b/.github/.lycheeignore index 972ca61..dc88a07 100644 --- a/.github/.lycheeignore +++ b/.github/.lycheeignore @@ -1,2 +1,3 @@ # Ignorefile for broken link check localhost +mvnrepository.com