๐๏ธ Shared CI for Konflux Task repos
This repo provides the shared scripts and CI workflows crucial for developing
Konflux Tasks.
To include the shared CI in your repo, see the onboarding steps.
For further post-onboarding information, see the SHARED-CI.md
doc in this repo or the copy brought in by the onboarding process to your own repo.
๐ Onboarding
Pre-requisites:
- Install
cruft
Tip
If you have uv installed, you can run uvx cruft and don't need
to install cruft itself.
Process:
-
Check that the onboarding process will not destroy your local changes
git status --short .github/ hack/ SHARED-CI.md
This command will print all the files the process could affect.
Commit any changes that you don't want to lose. -
Run the
cruft createcommandcruft create https://github.com/konflux-ci/task-repo-shared-ci --no-input --overwrite-if-exists
-
Restore the files that got deleted in the process
git diff --diff-filter=D --name-only -- .github/ hack/ | xargs git checkout -- -
If you use Renovate, create/update your renovate.json using the
hack/renovate-ignore-shared-ci.shscript
(see why):hack/renovate-ignore-shared-ci.sh
-
Commit the files brought in during the onboarding
git add .cruft.json renovate.json .github/ hack/ SHARED-CI.md git commit
Optional, but recommended: to receive periodic updates for the shared CI, set up
the Shared CI Updater requirements.
๐ค Contributing
See CONTRIBUTING.md.