-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add build pipeline, GitHub actions, issue templates and license
- Loading branch information
1 parent
3584b2c
commit a9e95a0
Showing
22 changed files
with
591 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file | ||
# Ignore build and test binaries. | ||
bin/ | ||
testbin/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
name: 🐛 Bug report | ||
description: Create a report to help us improve 🎉 | ||
labels: | ||
- bug | ||
|
||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Additional Context | ||
description: Add any other context about the problem here. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Logs | ||
description: If applicable, add logs to help explain the bug. | ||
render: shell | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: expected_behavior | ||
attributes: | ||
label: Expected Behavior | ||
description: A clear and concise description of what you expected to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduction_steps | ||
attributes: | ||
label: Steps To Reproduce | ||
description: Describe steps to reproduce the behavior | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: version | ||
attributes: | ||
label: Versions | ||
placeholder: v1.2.3 | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
name: 🚀 Feature request | ||
description: Suggest an idea for this project 💡 | ||
labels: | ||
- enhancement | ||
|
||
body: | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: Summary | ||
value: | | ||
**As** role name\ | ||
**I want** a feature or functionality\ | ||
**So that** I get certain business value | ||
description: This user story helps us to quickly understand what this idea is about. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Context | ||
description: Add more information here. You are completely free regarding form and length. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: out_of_scope | ||
attributes: | ||
label: Out of Scope | ||
description: List aspects that are explicitly not part of this feature | ||
placeholder: | | ||
- ... | ||
- ... | ||
- ... | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: links | ||
attributes: | ||
label: Further links | ||
description: URLs of relevant Git repositories, PRs, Issues, etc. | ||
placeholder: | | ||
- #567 | ||
- https://kubernetes.io/docs/reference/ | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: acceptance_criteria | ||
attributes: | ||
label: Acceptance Criteria | ||
description: If you already have ideas what the detailed requirements are, please list them below in given-when-then expressions. | ||
placeholder: | | ||
- Given a precondition, when an action happens, then expect a result | ||
```gherkin | ||
Given a precondition | ||
When an action happens | ||
Then expect a result | ||
``` | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: implementation_idea | ||
attributes: | ||
label: Implementation Ideas | ||
description: If applicable, shortly list possible implementation ideas | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## Summary | ||
|
||
* Short summary of what's included in the PR | ||
* Give special note to breaking changes | ||
|
||
## Checklist | ||
|
||
- [ ] Categorize the PR by setting a good title and adding one of the labels: | ||
`bug`, `enhancement`, `documentation`, `change`, `breaking`, `dependency` | ||
as they show up in the changelog | ||
- [ ] Update tests. | ||
- [ ] Link this PR to related issues. | ||
|
||
<!-- | ||
Remove items that do not apply. For completed items, change [ ] to [x]. | ||
NOTE: these things are not required to open a PR and can be done afterwards, | ||
while the PR is open. | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
{ | ||
"pr_template": "- ${{TITLE}} (#${{NUMBER}})", | ||
"categories": [ | ||
{ | ||
"title": "## 🚀 Features", | ||
"labels": [ | ||
"enhancement" | ||
] | ||
}, | ||
{ | ||
"title": "## 🛠️ Minor Changes", | ||
"labels": [ | ||
"change" | ||
] | ||
}, | ||
{ | ||
"title": "## 🔎 Breaking Changes", | ||
"labels": [ | ||
"breaking" | ||
] | ||
}, | ||
{ | ||
"title": "## 🐛 Fixes", | ||
"labels": [ | ||
"bug" | ||
] | ||
}, | ||
{ | ||
"title": "## 📄 Documentation", | ||
"labels": [ | ||
"documentation" | ||
] | ||
}, | ||
{ | ||
"title": "## 🔗 Dependency Updates", | ||
"labels": [ | ||
"dependency" | ||
] | ||
} | ||
], | ||
"template": "${{CATEGORIZED_COUNT}} changes since ${{FROM_TAG}}\n\n${{CHANGELOG}}" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Build | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- master | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
go: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Determine Go version from go.mod | ||
run: echo "GO_VERSION=$(grep "go 1." go.mod | cut -d " " -f 2 | cut -d "." -f 1,2)" >> $GITHUB_ENV | ||
|
||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: ${{ env.GO_VERSION }} | ||
|
||
- name: Run build | ||
run: make build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: Lint | ||
|
||
on: | ||
pull_request: {} | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Determine Go version from go.mod | ||
run: echo "GO_VERSION=$(grep "go 1." go.mod | cut -d " " -f 2 | cut -d "." -f 1,2)" >> $GITHUB_ENV | ||
|
||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: ${{ env.GO_VERSION }} | ||
|
||
- name: Run linters | ||
run: make lint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
name: Release | ||
|
||
on: | ||
push: | ||
tags: | ||
- "*" | ||
|
||
jobs: | ||
goreleaser: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Determine Go version from go.mod | ||
run: echo "GO_VERSION=$(grep "go 1." go.mod | cut -d " " -f 2 | cut -d "." -f 1,2)" >> $GITHUB_ENV | ||
|
||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: ${{ env.GO_VERSION }} | ||
|
||
- name: Set up QEMU | ||
uses: docker/setup-qemu-action@v3 | ||
|
||
- name: Set up Docker Buildx | ||
uses: docker/setup-buildx-action@v3 | ||
|
||
- name: Login to ghcr.io | ||
uses: docker/login-action@v3 | ||
with: | ||
registry: ghcr.io | ||
username: ${{ github.repository_owner }} | ||
password: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Build changelog from PRs with labels | ||
id: build_changelog | ||
uses: mikepenz/release-changelog-builder-action@v4 | ||
with: | ||
configuration: ".github/changelog-configuration.json" | ||
# PreReleases still get a changelog, but the next full release gets a diff since the last full release, | ||
# combining possible changelogs of all previous PreReleases in between. | ||
# PreReleases show a partial changelog since last PreRelease. | ||
ignorePreReleases: "${{ !contains(github.ref, '-rc') }}" | ||
outputFile: .github/release-notes.md | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Publish releases | ||
uses: goreleaser/goreleaser-action@v6 | ||
with: | ||
args: release --release-notes .github/release-notes.md | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
REGISTRY: ghcr.io | ||
IMAGE_NAME: ${{ github.repository }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Test | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- master | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Determine Go version from go.mod | ||
run: echo "GO_VERSION=$(grep "go 1." go.mod | cut -d " " -f 2 | cut -d "." -f 1,2)" >> $GITHUB_ENV | ||
|
||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: ${{ env.GO_VERSION }} | ||
|
||
- name: Run tests | ||
run: make test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
|
||
# Binaries for programs and plugins | ||
*.exe | ||
*.exe~ | ||
*.dll | ||
*.so | ||
*.dylib | ||
bin | ||
testbin/* | ||
Dockerfile.cross | ||
gitlab-scheduled-merge | ||
|
||
# Goreleaser | ||
dist/ | ||
.github/release-notes.md | ||
|
||
# Test binary, build with `go test -c` | ||
*.test | ||
|
||
# Output of the go coverage tool, specifically when used with LiteIDE | ||
*.out | ||
|
||
# Kubernetes Generated files - skip generated files, except for vendored files | ||
|
||
!vendor/**/zz_generated.* | ||
|
||
# editor and IDE paraphernalia | ||
.idea | ||
*.swp | ||
*.swo | ||
*~ |
Oops, something went wrong.