Skip to content

Commit 94626e1

Browse files
committed
chore: ci, linting, and community docs
1 parent 8c2acdb commit 94626e1

35 files changed

+1222
-152
lines changed

.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @aiven/team-space-invaders

.github/ISSUE_TEMPLATE/01_question.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: ❓ Ask a question
3+
about: Got stuck or missing something from the docs? Ask away!
4+
---
5+
6+
# Fill the question form below and remove this heading
7+
8+
## What can we help you with?
9+
10+
<!-- Try to explain your question with as much detail as you can provide. -->
11+
12+
## Where would you expect to find this information?
13+
14+
<!-- Feel free to point us where with links or even proposing new sections or pages in the documentation. -->

.github/ISSUE_TEMPLATE/02_bug.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 🐜 Report a bug
3+
about: Spotted a problem? Let us know
4+
---
5+
6+
# Fill the bug report form below and remove this heading
7+
8+
## What happened?
9+
10+
<!-- Try to be as precise as possible. If you can a small reproducer example would be great! -->
11+
12+
## What did you expect to happen?
13+
14+
<!-- Please explain what would be the expected behavior for this particular case, ideally, with examples. -->
15+
16+
## What else do we need to know?
17+
18+
<!-- Include your platform, version, and any other information that seems relevant. -->

.github/ISSUE_TEMPLATE/03_feature.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 💡 Feature suggestion
3+
about: What would make this even better?
4+
---
5+
6+
# Fill the feature suggestion form below and remove this heading
7+
8+
## What is currently missing?
9+
10+
<!-- Please, describe what is currently missing and why should it be present in the project. -->
11+
12+
## How could this be improved?
13+
14+
<!-- If you already know how this could be approached, please provide some brief explanation about it. -->
15+
16+
## Is this a feature you would work on yourself?
17+
18+
- [ ] I plan to open a pull request for this feature

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Aiven Security Bug Bounty
4+
url: https://hackerone.com/aiven_ltd
5+
about: Our bug bounty program.

.github/PULL_REQUEST_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- All contributors please complete these sections, including maintainers -->
2+
3+
# Fill the pull request form below and remove this heading
4+
5+
## About this change - What it does
6+
7+
<!-- Provide a small sentence that summarizes the change. -->
8+
9+
<!-- Provide the issue number below if it exists. -->
10+
11+
Resolves: #xxxxx
12+
13+
## Why this way
14+
15+
<!-- Provide a small explanation on why this is the approach you took for solving this problem. -->

.github/workflows/codeql-analysis.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: CodeQL
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
types:
8+
- opened
9+
- synchronize
10+
- reopened
11+
- labeled
12+
- unlabeled
13+
push:
14+
branches:
15+
- main
16+
17+
permissions:
18+
actions: read
19+
contents: read
20+
security-events: write
21+
22+
jobs:
23+
codeql:
24+
runs-on: ubuntu-latest
25+
if: >
26+
(github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'skip workflows')) ||
27+
github.event_name == 'push'
28+
strategy:
29+
fail-fast: false
30+
matrix:
31+
language:
32+
- go
33+
steps:
34+
- uses: actions/checkout@v4
35+
with:
36+
fetch-depth: 0
37+
- uses: actions/setup-go@v5
38+
with:
39+
go-version-file: go.mod
40+
- uses: github/codeql-action/init@v3
41+
with:
42+
languages: "${{ matrix.language }}"
43+
- uses: github/codeql-action/autobuild@v3
44+
- uses: github/codeql-action/analyze@v3

.github/workflows/lint.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Lint
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
types:
8+
- opened
9+
- synchronize
10+
- reopened
11+
- labeled
12+
- unlabeled
13+
push:
14+
branches:
15+
- main
16+
17+
permissions: read-all
18+
19+
jobs:
20+
commitlint:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v3
24+
with:
25+
fetch-depth: 0
26+
- uses: wagoid/commitlint-github-action@v5
27+
trunk:
28+
if: >
29+
(github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'skip workflows')) ||
30+
github.event_name == 'push'
31+
runs-on: ubuntu-latest
32+
steps:
33+
- uses: actions/checkout@v3
34+
with:
35+
fetch-depth: 0
36+
- uses: actions/setup-go@v4
37+
with:
38+
go-version-file: go.mod
39+
- uses: trunk-io/trunk-action@v1

.github/workflows/test.yml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Test
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
types:
8+
- opened
9+
- synchronize
10+
- reopened
11+
- labeled
12+
- unlabeled
13+
push:
14+
branches:
15+
- main
16+
workflow_dispatch: {}
17+
18+
permissions: read-all
19+
20+
jobs:
21+
test:
22+
if: >
23+
(github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'skip workflows')) ||
24+
github.event_name == 'push'
25+
runs-on: ubuntu-latest
26+
steps:
27+
- uses: actions/setup-go@v4
28+
with:
29+
go-version-file: go.mod
30+
- uses: actions/checkout@v3
31+
with:
32+
fetch-depth: 0
33+
- uses: arduino/setup-task@v1
34+
- run: task test

.github/workflows/trunk-upgrade.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Upgrade Trunk
2+
3+
on:
4+
schedule:
5+
- cron: 0 8 * * 1-5
6+
workflow_dispatch: {}
7+
8+
permissions: read-all
9+
10+
jobs:
11+
trunk_upgrade:
12+
runs-on: ubuntu-latest
13+
14+
permissions:
15+
contents: write
16+
pull-requests: write
17+
18+
steps:
19+
- uses: actions/checkout@v3
20+
with:
21+
fetch-depth: 0
22+
- uses: actions/setup-go@v5
23+
with:
24+
go-version-file: go.mod
25+
- uses: trunk-io/trunk-action/upgrade@v1
26+
with:
27+
prefix: "ci(deps): "
28+
lowercase-title: true

0 commit comments

Comments
 (0)