Add comprehensive project README #18
This file contains hidden or 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
| # SPDX-FileCopyrightText: Copyright 2025 Stacklok, Inc. | |
| # SPDX-License-Identifier: Apache-2.0 | |
| name: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| env: | |
| GO_VERSION: "1.25" | |
| GOPRIVATE: github.com/stacklok/* | |
| jobs: | |
| test: | |
| name: Test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| cache: true | |
| - name: Configure Git for private modules | |
| run: | | |
| git config --global url."https://${{ github.actor }}:${{ secrets.GO_MODULE_TOKEN }}@github.com/".insteadOf "https://github.com/" | |
| - name: Install Task | |
| run: | | |
| sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin | |
| - name: Build apiary-init (for go:embed) | |
| run: | | |
| mkdir -p internal/infra/vm/initbin | |
| CGO_ENABLED=0 GOOS=linux go build -ldflags "-s -w" -o internal/infra/vm/initbin/apiary-init ./cmd/apiary-init | |
| - name: Run tests | |
| run: | | |
| task test | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| cache: true | |
| - name: Configure Git for private modules | |
| run: | | |
| git config --global url."https://${{ github.actor }}:${{ secrets.GO_MODULE_TOKEN }}@github.com/".insteadOf "https://github.com/" | |
| - name: Install Task | |
| run: | | |
| sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin | |
| - name: Build apiary-init (for go:embed) | |
| run: | | |
| mkdir -p internal/infra/vm/initbin | |
| CGO_ENABLED=0 GOOS=linux go build -ldflags "-s -w" -o internal/infra/vm/initbin/apiary-init ./cmd/apiary-init | |
| - name: Run linter | |
| run: | | |
| task lint | |
| build: | |
| name: Build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| cache: true | |
| - name: Configure Git for private modules | |
| run: | | |
| git config --global url."https://${{ github.actor }}:${{ secrets.GO_MODULE_TOKEN }}@github.com/".insteadOf "https://github.com/" | |
| - name: Build apiary-init (for go:embed) | |
| run: | | |
| mkdir -p internal/infra/vm/initbin | |
| CGO_ENABLED=0 GOOS=linux go build -ldflags "-s -w" -o internal/infra/vm/initbin/apiary-init ./cmd/apiary-init | |
| - name: Verify compilation | |
| run: | | |
| CGO_ENABLED=0 go build ./... |