diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 0000000..68f8d9a --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,17 @@ +# Garden Linux Builder CI Workflows + +## `build.yml` + +Build container images on all branches. + +For pushes on the `main` branch, tags based on the git sha are created and pushed to the container registry and a pseudo-release called `latest` is updated on GitHub. +This allows users to follow a rolling-release approach if they desire. + +## `release.yml` + +Tag container images and create GitHub Releases. +This workflow only runs on demand (workflow dispatch). +It should be run if a new release is desired. +The workflow dispatch needs a parameter `component` which specifies which version component should be increased. +This is either `minor` (the default) or `major`. +`major` should be picked in cases where the new version has breaking changes (for example between the `build` script and the container image). diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index bc8c13a..4ca4e37 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,7 +4,7 @@ on: inputs: component: description: 'Version component to increment (Use *minor* unless we have breaking changes)' - required: false + required: true type: choice options: - minor