Files
grafana/.github/workflows/pr-backend-code-checks.yml
Jev Forsberg 83c3c01769 Chore: Migrate pr-swagger-gen from Drone to GHAs (#102157)
* baldm0mma/ update swagger step

* baldm0mma/ update with correct wire tags

* baldm0mma/ add write token permissions

* baldm0mma/ make swagger-clean && make openapi3-gen

* baldm0mma/ remove wire_tags

* Reset OpenAPI specs to main branch version

* baldm0mma/ regen specs with enterprise running

* baldm0mma/ test go version issue

* baldm0mma/ test with building with go 1.24.1

* baldm0mma/ add comment
2025-03-17 09:28:24 -06:00

67 lines
2.2 KiB
YAML

name: Backend Code Checks
description: Validate go.mod and OpenAPI specifications
on:
pull_request:
paths-ignore:
- '*.md'
- 'docs/**'
- 'latest.json'
permissions:
contents: read
id-token: write
jobs:
validate-configs:
name: Validate Backend Configs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v5
with:
# Explicitly set Go version to 1.24.1 to ensure consistent OpenAPI spec generation
# The crypto/x509 package has additional fields in Go 1.24.1 that affect the generated specs
# This ensures the GHAs environment matches what we use in the Drone pipeline
go-version: 1.24.1
cache: true
- name: Verify code generation
run: |
CODEGEN_VERIFY=1 make gen-cue
CODEGEN_VERIFY=1 make gen-jsonnet
- name: Validate go.mod
run: go run scripts/modowners/modowners.go check go.mod
# Enterprise setup is needed for complete OpenAPI spec generation
# We only do this for internal PRs
- name: Setup Grafana Enterprise
if: github.event.pull_request.head.repo.fork == false
uses: ./.github/actions/setup-enterprise
- name: Generate and Validate OpenAPI Specs
run: |
# For forks, we'll just run the basic swagger-gen without validation
if [[ "${{ github.event.pull_request.head.repo.fork }}" == "true" ]]; then
echo "PR is from a fork, skipping enterprise-based validation"
make swagger-gen
exit 0
fi
# Clean and regenerate OpenAPI specs
make swagger-clean && make openapi3-gen
# Check if the generated specs differ from what's in the PR
for f in public/api-merged.json public/openapi3.json; do git add $f; done
if [ -z "$(git diff --name-only --cached)" ]; then
echo "OpenAPI specs are up to date!"
else
echo "OpenAPI specs are OUT OF DATE!"
git diff --cached
echo "Please ensure the branch is up-to-date, then regenerate the specification by running make swagger-clean && make openapi3-gen"
exit 1
fi