build/pre-commit-tooling #5
5 changed files with 136 additions and 0 deletions
41
.forgejo/workflows/pull-request.yml
Normal file
41
.forgejo/workflows/pull-request.yml
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
name: Pull-Request
|
||||||
|
on: [pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
static-analysis:
|
||||||
|
runs-on: runner-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: 1.23
|
||||||
|
- name: Validate Yaml
|
||||||
|
run: pipx run pre-commit run check-yaml -a
|
||||||
|
- name: Validate shell scripts
|
||||||
|
run: pipx run pre-commit run shellcheck -a
|
||||||
|
- name: Check formatting
|
||||||
|
run: pipx run pre-commit run go-fmt -a
|
||||||
|
- name: Check code patterns
|
||||||
|
run: pipx run pre-commit run go-vet-mod -a
|
||||||
|
tests:
|
||||||
|
runs-on: runner-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: 1.23
|
||||||
|
- name: Tests
|
||||||
|
run: pipx run pre-commit run go-test-mod -a
|
||||||
|
post-run:
|
||||||
|
runs-on: runner-latest
|
||||||
|
needs: [static-analysis,tests]
|
||||||
|
if: ${{ always() }}
|
||||||
|
steps:
|
||||||
|
- name: Export trace
|
||||||
|
uses: https://forge.karnov.club/marc/opentelemetry-trace-export-forgejo-action@main
|
||||||
|
with:
|
||||||
|
otlp-endpoint: "http://otel.home.karnov.club:4318"
|
||||||
|
forgejo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
forgejo-base-url: ${{ env.GITHUB_SERVER_URL }}
|
||||||
|
run-id: ${{ env.GITHUB_RUN_NUMBER }}
|
||||||
|
repo-name: ${{ env.GITHUB_REPOSITORY }}
|
||||||
67
.forgejo/workflows/push.yml
Normal file
67
.forgejo/workflows/push.yml
Normal file
|
|
@ -0,0 +1,67 @@
|
||||||
|
name: Push
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
pre-run:
|
||||||
|
runs-on: runner-latest
|
||||||
|
steps:
|
||||||
|
- uses: https://forge.karnov.club/marc/push-status-to-discord-action@main
|
||||||
|
with:
|
||||||
|
webhook-url: ${{secrets.DISCORD_WEBHOOK_URL}}
|
||||||
|
status: "Started"
|
||||||
|
init: true
|
||||||
|
static-analysis:
|
||||||
|
runs-on: runner-latest
|
||||||
|
needs: [pre-run]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: 1.23
|
||||||
|
- name: Validate Yaml
|
||||||
|
run: pipx run pre-commit run check-yaml -a
|
||||||
|
- name: Validate shell scripts
|
||||||
|
run: pipx run pre-commit run shellcheck -a
|
||||||
|
- name: Check formatting
|
||||||
|
run: pipx run pre-commit run go-fmt -a
|
||||||
|
- name: Check code patterns
|
||||||
|
run: pipx run pre-commit run go-vet-mod -a
|
||||||
|
tests:
|
||||||
|
runs-on: runner-latest
|
||||||
|
needs: [pre-run]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: 1.23
|
||||||
|
- name: Tests
|
||||||
|
run: pipx run pre-commit run go-test-mod -a
|
||||||
|
post-run:
|
||||||
|
runs-on: runner-latest
|
||||||
|
needs: [static-analysis,tests]
|
||||||
|
steps:
|
||||||
|
- name: Export trace
|
||||||
|
uses: https://forge.karnov.club/marc/opentelemetry-trace-export-forgejo-action@main
|
||||||
|
with:
|
||||||
|
otlp-endpoint: "http://otel.home.karnov.club:4318"
|
||||||
|
forgejo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
forgejo-base-url: ${{ env.GITHUB_SERVER_URL }}
|
||||||
|
run-id: ${{ env.GITHUB_RUN_NUMBER }}
|
||||||
|
repo-name: ${{ env.GITHUB_REPOSITORY }}
|
||||||
|
- name: Notify success
|
||||||
|
uses: https://forge.karnov.club/marc/push-status-to-discord-action@main
|
||||||
|
if: ${{always() && success()}}
|
||||||
|
with:
|
||||||
|
webhook-url: ${{secrets.DISCORD_WEBHOOK_URL}}
|
||||||
|
status: "Success"
|
||||||
|
variant: "success"
|
||||||
|
- name: Notify failure
|
||||||
|
uses: https://forge.karnov.club/marc/push-status-to-discord-action@main
|
||||||
|
if: ${{always() && failure()}}
|
||||||
|
with:
|
||||||
|
webhook-url: ${{secrets.DISCORD_WEBHOOK_URL}}
|
||||||
|
status: "Failure"
|
||||||
|
variant: "failure"
|
||||||
|
|
||||||
16
.pre-commit-config.yaml
Normal file
16
.pre-commit-config.yaml
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
---
|
||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v4.6.0
|
||||||
|
hooks:
|
||||||
|
- id: check-yaml
|
||||||
|
- repo: https://github.com/shellcheck-py/shellcheck-py
|
||||||
|
rev: v0.10.0.1
|
||||||
|
hooks:
|
||||||
|
- id: shellcheck
|
||||||
|
- repo: https://github.com/tekwizely/pre-commit-golang
|
||||||
|
rev: master
|
||||||
|
hooks:
|
||||||
|
- id: go-test-mod
|
||||||
|
- id: go-fmt
|
||||||
|
- id: go-vet-mod
|
||||||
|
|
@ -22,3 +22,7 @@ curl https://forge.karnov.club/spadinastan/spud/raw/branch/main/install.sh | bas
|
||||||
|
|
||||||
To pull a specific version, supply a `$SPUD_VERSION` that corresponds to an existing release tag, and to control where
|
To pull a specific version, supply a `$SPUD_VERSION` that corresponds to an existing release tag, and to control where
|
||||||
the binary is unpacked and installed, supply `$SPUD_ROOT`.
|
the binary is unpacked and installed, supply `$SPUD_ROOT`.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
The `bootstrap.sh` script should be run to prepare any pre-commit hooks and other required tooling for local development. Checks can be run manually via `pipx run pre-commit run -a`.
|
||||||
|
|
|
||||||
8
bootstrap.sh
Executable file
8
bootstrap.sh
Executable file
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
if [[ -z "$(command -v pipx)" ]]; then
|
||||||
|
echo "ERROR: Pre-commit tooling requires pipx to be available."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
pipx run pre-commit install
|
||||||
Loading…
Reference in a new issue