Skip to content

ci: Add Release Please automation and comprehensive CI checks#11

Open
panbanda wants to merge 8 commits intotoon-format:mainfrom
panbanda:ci/setup-please-commit-workflows
Open

ci: Add Release Please automation and comprehensive CI checks#11
panbanda wants to merge 8 commits intotoon-format:mainfrom
panbanda:ci/setup-please-commit-workflows

Conversation

@panbanda
Copy link

@panbanda panbanda commented Nov 18, 2025 •
edited
Loading

Summary

This PR implements automated release management using Release Please and adds comprehensive CI validation. The workflows enforce semantic versioning, automate changelog generation, and ensure code quality through multiple validation steps.

Changes

CI Workflow (.github/workflows/ci.yml)

Runs on main branch pushes and all PRs with the following jobs:

  1. Verify Dependencies - Ensures go.mod and go.sum are clean via go mod verify and go mod tidy
  2. Test Matrix (Go 1.23, 1.24, 1.25)
    • go vet ./... - Static analysis
    • go test ./... - Unit tests with coverage
    • go test -race ./... - Race condition detection
  3. Security Scan - govulncheck ./... for vulnerability detection
  4. Lint - golangci-lint for code quality

PR Validation Workflow (.github/workflows/pr-validation.yml)

Runs only on PRs:

  • Validate PR Title - Enforces Conventional Commits format (feat, fix, docs, etc.)
  • Requires subject to start with uppercase letter

Release Please Workflow (.github/workflows/release.yml)

Automates releases on main branch:

  • Creates release PRs based on conventional commits
  • Generates semantic version bumps (feat→minor, fix→patch)
  • Produces grouped changelogs (Features, Bug Fixes, Performance, etc.)

Configuration Files

  • .release-please-manifest.json - Tracks current version (starting at 0.1.0)
  • release-please-config.json - Configures changelog sections and release behavior

Removed Files

  • .github/workflows/tests.yml - Consolidated into ci.yml

Benefits

  • Automated Releases: No manual version bumping or changelog writing
  • Quality Assurance: Catches bugs, race conditions, and vulnerabilities before merge
  • Dependency Safety: Ensures go.mod/go.sum integrity
  • Semantic Versioning: Automatic version management based on commit types
  • Better History: Enforced conventional commits create searchable, meaningful history
  • No Duplication: Single CI workflow runs on both main and PRs

Testing

Workflows activate on this PR to demonstrate:

  • PR title validation (separate workflow)
  • Full test suite across Go versions
  • Security scanning
  • Linting checks
  • Dependency verification

Once merged to main, Release Please will create the first release PR automatically.

@panbanda
ci: Add Release Please automation and comprehensive CI checks
f59799d 
Implement automated release management using Release Please with
semantic versioning and changelog generation. Add comprehensive CI
pipeline for pull requests including dependency verification, security
scanning, and race condition detection.

Changes:
- CI workflow validates PR titles, runs tests across Go 1.23-1.25,
  performs security scans with govulncheck, and runs linting
- Release Please workflow automates version bumping, changelog
  generation, and major/minor tag management
- go vet and race detector added to catch concurrency issues
- go mod verification ensures dependency integrity

Release Please will automatically:
- Create release PRs based on conventional commits
- Generate semantic version bumps (feat=minor, fix=patch)
- Group changelog entries by type (Features, Bug Fixes, etc.)
- Update v1 and v1.x tags for easy dependency pinning
@panbanda panbanda requested a review from a team as a code owner November 18, 2025 00:32
@panbanda panbanda mentioned this pull request Nov 18, 2025
Open
@panbanda
fix(ci): Remove typo and simplify release workflow
aac5860 
- Fix typo in setup-go action version (v5s -> v5)
- Remove redundant test run from release workflow (already validated in CI)
- Remove major/minor tag management (not used in Go ecosystem)
@panbanda
chore(ci): Remove develop branch from tests workflow
d372fc9 
Keep workflow triggers consistent with main branch only
@panbanda
Copy link
Author

panbanda commented Nov 18, 2025

@alpkeskin simplified it a bit and fixed some typos after seeing the last run.

@panbanda
refactor(ci): Consolidate workflows and fix Go versions
c163f9b 
- Remove tests.yml in favor of unified ci.yml workflow
- Update ci.yml to run on both main branch pushes and PRs
- Fix Go version references: change 1.25 (unreleased) to 'stable'
- Update test matrix to use only released Go versions (1.23, 1.24)
@panbanda
fix(ci): Restore Go 1.25 to test matrix
dc25635 
Go 1.25 is released, restore it to the test matrix
@panbanda
refactor(ci): Separate PR validation into dedicated workflow
9e84b49 
- Move PR title validation to pr-validation.yml
- Runs only on PRs (not main branch pushes)
- CI workflow now focused on tests, linting, and security
@panbanda panbanda requested a review from alpkeskin November 18, 2025 17:40
@panbanda
fix(ci): Run workflows only on PRs targeting main
262adb4 
- Remove push trigger from ci.yml (redundant after PR validation)
- Explicitly set branches: [main] on both workflows
- CI runs when PRs target main, not on main branch pushes
@tusgino
Copy link

tusgino commented Nov 19, 2025

Is this PR ready yet? @panbanda

@panbanda
Copy link
Author

panbanda commented Nov 19, 2025

@tusgino yes, I won't know if it passes until approved unfortunately. But this should work

johannschopplich
johannschopplich requested changes Mar 8, 2026
View reviewed changes
Copy link
Contributor

@johannschopplich johannschopplich left a comment

Choose a reason for hiding this comment

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

The release automation is well-structured and the changelog configuration is sensible. 👍 One important fix before we merge:

ci.yml is missing a push: branches: [main] trigger. Currently CI only runs on pull requests, which means Release Please's own merge commits land on main unvalidated. Adding a push trigger closes that gap.

A few smaller things:

  • Pin govulncheck to a specific version rather than @latest to avoid silent breakage on tool updates
  • Go 1.25 in the matrix doesn't exist yet, worth confirming it resolves or removing until GA (pre-existing, not introduced here)
  • The uppercase PR title convention in pr-validation.yml is non-standard, worth a note in CONTRIBUTING.md

The push trigger is the only must-have. Everything else can be followed up separately if preferred.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@johannschopplich johannschopplich johannschopplich requested changes

@alpkeskin alpkeskin alpkeskin approved these changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@panbanda @tusgino @johannschopplich @alpkeskin