Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.61 KB

README.md

File metadata and controls

53 lines (32 loc) · 2.61 KB
Raw

Release Tools

This project contains, or should contain, all of the configuration and automation to maintain, build, and release Konveyor.

Check out the config.yaml to see:

  1. The repositories we are managing
  2. The Labels we are configuring in repositories
  3. The milestones we are configuring in repositories

This allows us to have a single source of truth to make sure that, as we create enhancments, issues, and pull requests, they can be tracked properly.

You can find our reusable GitHub Workflows in ./.github/workflows.

Available Workflows

Prepare repository for release

See workflow file here

This workflow should be called when a new release branch is created. When invoked, it does the following:

  • update specified base images in the Dockerfile to use the right release tags
  • update specified golang deps to track the right release branch
  • commits the results back to the originating branch

Before doing the actual changes, it checks if the originating branch matches the pattern release-X.Y where X and Y are integers representing major and minor versions for the release.

It accepts following inputs:

  • branch_ref (Required): This is the ref of the branch. Only branches of format refs/heads/release-X.Y will enable the workflow to do the actual replacement of tags in Dockerfile. All other branches are ignored. ${{ github.ref }} in the original repo should be used to get the value for this variable.

  • images_to_update: This is a list of images in the Dockerfile for which you want to update the tags. It should be a JSON array string e.g. '["quay.io/konveyor/operator"]'. Defaults to '[]'.

  • go_deps_to_update: This is a list of go deps in the go.mod file for which you want to update the branches. It should be a JSON array string e.g. '["github.com/konveyor/analyzer-lsp"]'. Defaults to '[]'.

  • dockerfile: This is the relative path to the Dockerfile in the repo. Defaults to ./Dockerfile.

Contributing

We welcome contributions to this project! If you're interested in contributing, please read the konveyor/community CONTRIBUTING doc for more information on how to get started.

Code of Conduct

Refer to Konveyor's Code of Conduct here.

License

FOSSA Status