Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
99 lines (64 loc) · 4.26 KB

DEVELOPMENT.md

File metadata and controls

99 lines (64 loc) · 4.26 KB

Development and Testing

Local Development

Since this is a Go library, there is no application to run.

Running tests

To run all tests:

go test ./...

Mocks

We use the built-in mock library and use mockgen to generate the mock implementation of Interfaces for testing.

To generate mocks:

go generate ./...

We make use of go:generate comments to instruct which mockgen commands should be run.

Coding style

goimports is enforced via a CI step. It is up to the individual developer to ensure their change complies with this.

Static analysis and linting

Static analysis tools and linters are run as part of CI. They come from golangci-lint. To run this locally:

# Must be in a directory with a go.mod file
cd <directory_with_go_module>
golangci-lint run ./...

Precommit

A pre-commit hook configuration is provided to enforce some tasks on git commit. Run pre-commit install to install pre-commit into your git hooks. pre-commit will now run on every commit.

If you want to manually run all pre-commit hooks on a repository without creating hooks, run pre-commit run --all-files.

To run individual hooks use pre-commit run <hook_id>.

Dependency upgrades

For dependency upgrades, dependabot is relied upon and news files are auto-generated in order to document such change. Nonetheless, due to a change in GitHub actions, secrets are not available in the build triggered by the pull request unless they are re-run manually. So please re-run every dependabot PR CI jobs.

Releasing

Release Types

The CI supports three release flows:

  • development for snapshot releases
  • release for stable releases
  • beta for pre-releases
Type Purpose Version Number Format GitHub Release News Files Deleted
Release General Availability <minor>.<major>.<patch> Yes Yes
Beta Integration Testing <minor>.<major>.<patch>-beta.<commit number> Yes No
Development Development Testing <minor>.<major>.<patch>-dev+<git hash> No No

⚠️ releases can be made from any branches but it is recommended that they are only made from the main branch.

Release workflow

  1. Navigate to the GitHub Actions page.
  2. Select the Run Workflow button and type which kind of release you would like to make (i.e. release, beta or development).

Version Numbers

The version number will be automatically calculated, based on the news files.

Detecting secrets

So that no secrets are committed back to the repository, a combination of two tools are run in CI:

  • GitLeaks : Scans the git history for usual secrets (e.g. AWS keys, etc.)
  • detect-secrets: Scans only the current state of the repository for anything which can look like secrets (strings with high entropy)

For the latter, False positive keys are stored in the baseline which detect-secrets checks against when it runs

Baseline & False positives

To flag individual false positives add comment # pragma: allowlist secret to line with secret

To add all suspected secrets in the repository (excluding ones with an allow secret comment), run detect-secrets scan --all-files --exclude-files '.*go\.sum$' --exclude-files '.*\.html$' --exclude-files '.*\.properties$' --exclude-files '\.git' > .secrets.baseline

If on Windows: then change the encoding of the .secrets.baseline file to UTF-8 then convert all \ to / in the .secrets.baseline file