Skip to content

Create go.yml #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
allyelvis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create go.yml #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/go.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# This workflow will build a golang project
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go

name: Go

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
Comment on lines +6 to +10

@sourcery-ai sourcery-ai Bot May 31, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Consider adding a manual workflow trigger

Including workflow_dispatch: allows you to trigger the workflow manually from the GitHub UI for ad-hoc testing.

Suggested change
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
workflow_dispatch:


jobs:

build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
Comment on lines +17 to +22

@sourcery-ai sourcery-ai Bot May 31, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (performance): Consider adding module and build cache to speed up CI

Adding an actions/cache step for ~/.cache/go-build and $GOPATH/pkg/mod after checkout can reduce CI build times.

Suggested change
- uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
- uses: actions/checkout@v4
- name: Cache Go modules and build cache
uses: actions/cache@v3
with:
path: |
~/.cache/go-build
${{ env.GOPATH }}/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'


- name: Build
run: go build -v ./...
Comment on lines +24 to +25

@sourcery-ai sourcery-ai Bot May 31, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Add an explicit dependency fetch step

Adding go mod download before go build ensures all modules are available and improves build caching efficiency.

Suggested change
- name: Build
run: go build -v ./...
- name: Download dependencies
run: go mod download
- name: Build
run: go build -v ./...


- name: Test

@sourcery-ai sourcery-ai Bot May 31, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (testing): Run tests with the race detector

Add -race to the test command in CI to detect data races in concurrent code.

run: go test -v ./...