Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.42 KB

DEVELOPERS.md

File metadata and controls

35 lines (25 loc) · 1.42 KB
Raw

Workflow

The development workflow is simple: develop feature, enhancement and fix its own separate branch, then make a pull request:

  • Don't merge PRs without one approving review.
  • Don't merge PRs if all tests don't pass.
  • Squash merge so that there is a single commit to the master for each PR that is a tested and working version of the software.

Releases

Release frequently, following semantic versioning.

To release, update the VERSION file to create and create a tag. An example workflow is below:

# edit the VERSION file, e.g. from '0.4.0-dev' to '0.4.0'
vim VERSION
# make a PR that bumps the version
git ...

# then create a tag and push.
git tag -a "v$(echo VERSION)" -m "tag and release version $(echo version)"
git push origin "v$(echo VERSION)"

# Then update the VERSION file to dev status again e.g. to '0.5.0-dev'
# And make a PR
git ...

CI/CD

There are two GitHub Actions workflows for that ensure that:

  1. the makefile and meson build systems can build, install working versions of squashfs-mount.
  2. the all artifacts can be built (currently a source RPM).

All workflows run on each push and PR. Furthermore, the artifacts workflow, .github/workflows/artifacts.yml, runs a tag-release job when a tag is created, that automatically generates a GitHub release and uploads the artifacts to the release.