Skip to content

Latest commit

 

History

History
98 lines (70 loc) · 3.73 KB

DEVELOPMENT.md

File metadata and controls

98 lines (70 loc) · 3.73 KB
Raw

Development

This document describes the intricacies of govy development workflow. If you see anything missing, feel free to contribute to this document :)

Pull requests

Pull request template is provided when you create new PR. Section worth noting and getting familiar with is located under ## Release Notes header.

Makefile

Govy ships with a Makefile which is well documented and should cover most if not all development cycle needs. Run make help to display short description for each target.

CI

Continuous integration pipelines utilize the same Makefile commands which you run locally within reproducible devbox environment. This ensures consistent behavior of the executed checks and makes local debugging easier.

Testing

You can run all unit tests with make test. We also encourage inspecting test coverage during development, you can verify if the paths you're interested in are covered with make test/coverage.

Releases

Govy adheres to the Go's official release workflow recommendations and requirements. Refer to the official Go docs for more details.

Release automation

We're using Release Drafter to automate release notes creation. Drafter also does its best to propose the next release version based on commit messages from main branch.

Release Drafter is also responsible for auto-labeling pull requests. It checks both title and body of the pull request and adds appropriate labels.
NOTE: The auto-labeling mechanism will not remove labels once they're created. For example, If you end up changing PR title from sec: to fix: you'll have to manually remove security label.

On each commit to main branch, Release Drafter will update the next release draft.

In addition to Release Drafter, we're also running a script which extracts explicitly listed release notes and breaking changes which are optionally defined in ## Release Notes and ## Breaking Changes headers. It also performs a cleanup of the PR draft mitigating Release Drafter shortcomings.

Code generation

Some parts of the codebase are automatically generated. We use the following tools to do that:

Validation

We're using our own validation library to write validation for all objects. Refer to this README.md for more information.

Dependencies

Renovate is configured to automatically merge minor and patch updates. For major versions, which sadly includes GitHub Actions, manual approval is required.

Tests coverage

Tests coverage reporting is automated using the following actions:

  • go-coverage-report which is responsible for updating the coverage badge in main README.md. It stores the coverage results in GitHub wiki and it can be easily inspected here. This action is run only on push events to main branch.
  • coverdiff which is executed on each PR runs the tests coverage and posts a summary report as a comment. It highlights positive and negative changes.

Benchmarks

github-action-benchmark is used to collect and store benchmarks' results. It inspects PRs and if a configured threshold difference between previous and current results is breached it will leave a comment on the affected PR.

On top of that it publishes benchmarks' history charts onto GitHub Pages.