Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/update-from-template' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
AB-xdev committed Jun 12, 2024
2 parents 8f7d3ca + f9d8378 commit 6bb2467
Show file tree
Hide file tree
Showing 20 changed files with 551 additions and 44 deletions.
7 changes: 7 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
# Auto detect text files and perform LF normalization
* text=auto

# Force sh files to have LF
*.sh text eol=lf

# Force MVN Wrapper Linux files LF
mvnw text eol=lf
.mvn/wrapper/maven-wrapper.properties text eol=lf
3 changes: 3 additions & 0 deletions .github/.lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ignorefile for broken link check
localhost
mvnrepository.com
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
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"
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -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
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -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."
38 changes: 38 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 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: automated
description: Created by an automation
color: '#000000'
- 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'
43 changes: 43 additions & 0 deletions .github/workflows/broken-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
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

- run: mv .github/.lycheeignore .lycheeignore

- 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
File renamed without changes.
20 changes: 10 additions & 10 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ permissions:
pull-requests: write

jobs:
check_code: # Validates the code
check-code:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -45,9 +45,9 @@ jobs:
exit 1
fi
prepare_release:
prepare-release:
runs-on: ubuntu-latest
needs: [check_code]
needs: [check-code]
outputs:
upload_url: ${{ steps.create_release.outputs.upload_url }}
steps:
Expand Down Expand Up @@ -93,8 +93,8 @@ jobs:
release_name: v${{ steps.version.outputs.release }}
commitish: master
body: |
## [Changelog](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }})
See [Changelog#v${{ steps.version.outputs.release }}](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }}) for more information.
## [Changelog](https://github.com/${{ github.repository }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }})
See [Changelog#v${{ steps.version.outputs.release }}](https://github.com/${{ github.repository }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }}) for more information.
## Installation
Add the following lines to your pom:
Expand All @@ -106,9 +106,9 @@ jobs:
</dependency>
```
publish_central: # Publish the code to central
publish-maven:
runs-on: ubuntu-latest
needs: [prepare_release]
needs: [prepare-release]
steps:
- uses: actions/checkout@v4

Expand Down Expand Up @@ -139,7 +139,7 @@ jobs:

publish-pages:
runs-on: ubuntu-latest
needs: [prepare_release]
needs: [prepare-release]
steps:
- uses: actions/checkout@v4

Expand All @@ -166,9 +166,9 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./${{ env.PRIMARY_MAVEN_MODULE }}/target/site

after_release:
after-release:
runs-on: ubuntu-latest
needs: [publish_central]
needs: [publish-maven]
steps:
- uses: actions/checkout@v4

Expand Down
18 changes: 15 additions & 3 deletions .github/workflows/sonar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,22 @@ env:
SONARCLOUD_HOST: https://sonarcloud.io

jobs:
sonar:
name: SonarCloud Scan
token-check:
runs-on: ubuntu-latest
if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}
if: ${{ !(github.event_name == 'pull_request' && startsWith(github.head_ref, 'renovate/')) }}
outputs:
hasToken: ${{ steps.check-token.outputs.has }}
steps:
- id: check-token
run: |
[ -z $SONAR_TOKEN ] && echo "has=false" || echo "has=true" >> "$GITHUB_OUTPUT"
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

sonar-scan:
runs-on: ubuntu-latest
needs: token-check
if: ${{ needs.token-check.outputs.hasToken }}
steps:
- uses: actions/checkout@v4
with:
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/sync-labels.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ env:
PRIMARY_MAVEN_MODULE: ${{ github.event.repository.name }}

jobs:
publish_central: # Publish the code to central
publish-maven:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
Loading

0 comments on commit 6bb2467

Please sign in to comment.