Skip to content

Commit

Permalink
chore: add selproj and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Serpentiel committed Jan 31, 2024
1 parent c6f3299 commit 1e65cd6
Show file tree
Hide file tree
Showing 29 changed files with 886 additions and 80 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @aiven/team-space-invaders
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/01_question.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ name: ❓ Ask a question
about: Got stuck or missing something from the docs? Ask away!
---

# What can we help you with?
# Fill the question form below and remove this heading

## What can we help you with?

<!-- Try to explain your question with as much detail as you can provide. -->

# Where would you expect to find this information?
## Where would you expect to find this information?

<!-- Feel free to point us where with links or even proposing new sections or pages in the documentation. -->

9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/02_bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ name: 🐜 Report a bug
about: Spotted a problem? Let us know
---

# What happened?
# Fill the bug report form below and remove this heading

## What happened?

<!-- Try to be as precise as possible. If you can a small reproducer example would be great! -->

# What did you expect to happen?
## What did you expect to happen?

<!-- Please explain what would be the expected behavior for this particular case, ideally, with examples. -->

# What else do we need to know?
## What else do we need to know?

<!-- Include your platform, version, and any other information that seems relevant. -->

10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/03_feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@ name: 💡 Feature suggestion
about: What would make this even better?
---

# What is currently missing?
# Fill the feature suggestion form below and remove this heading

## What is currently missing?

<!-- Please, describe what is currently missing and why should it be present in the project. -->

# How could this be improved?
## How could this be improved?

<!-- If you already know how this could be approached, please provide some brief explanation about it. -->

# Is this a feature you would work on yourself?
## Is this a feature you would work on yourself?

* [ ] I plan to open a pull request for this feature
- [ ] I plan to open a pull request for this feature
9 changes: 6 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
<!-- All contributors please complete these sections, including maintainers -->
# About this change - What it does

# Fill the pull request form below and remove this heading

## About this change - What it does

<!-- Provide a small sentence that summarizes the change. -->

<!-- Provide the issue number below if it exists. -->

Resolves: #xxxxx

# Why this way
## Why this way

<!-- Provide a small explanation on why this is the approach you took for solving this problem. -->

39 changes: 39 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: CodeQL

on:
pull_request:
branches:
- main
types:
- opened
- synchronize
- reopened
- labeled
- unlabeled
push:
branches:
- main

permissions:
actions: read
contents: read
security-events: write

jobs:
codeql:
runs-on: ubuntu-latest
if: >
(github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'skip workflows')) ||
github.event_name == 'push'
strategy:
fail-fast: false
matrix:
language:
- go
steps:
- uses: actions/checkout@v3
- uses: github/codeql-action/init@v2
with:
languages: "${{ matrix.language }}"
- uses: github/codeql-action/autobuild@v2
- uses: github/codeql-action/analyze@v2
31 changes: 31 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Lint

permissions: read-all

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
commitlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: wagoid/commitlint-github-action@v5
trunk:
if: >
(github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'skip workflows')) ||
github.event_name == 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v4
with:
go-version: stable
- uses: trunk-io/trunk-action@v1
26 changes: 26 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Test

permissions: read-all

on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch: {}

jobs:
test:
if: >
(github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'skip workflows')) ||
github.event_name == 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/setup-go@v4
with:
go-version: stable
- uses: actions/checkout@v3
- uses: arduino/setup-task@v1
- run: task test
23 changes: 23 additions & 0 deletions .github/workflows/trunk-upgrade.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Upgrade Trunk

on:
schedule:
- cron: 0 8 * * 1-5
workflow_dispatch: {}

permissions: read-all

jobs:
trunk_upgrade:
runs-on: ubuntu-latest

permissions:
contents: write
pull-requests: write

steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v5
with:
go-version: stable
- uses: trunk-io/trunk-action/upgrade@v1
Loading

0 comments on commit 1e65cd6

Please sign in to comment.