Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 3.06 KB

README.md

File metadata and controls

56 lines (41 loc) · 3.06 KB
Raw

Red Hat SecureSign Rekor

This repository holds the Red Hat fork of sigstore/rekor with modifications needed only for Red Hat.

Mirroring upstream

Mirroring HEAD from upstream main

The HEAD of the upstream repo, sigstore/rekor is mirrored on the release-next and release-next-ci branches using the redhat/release/update-to-head.sh script. When this script is run without any arguments, the following steps are taken.

  • The upstream HEAD is fetched and checked out as the release-next branch
  • The origin remote main branch is pulled and Red-Hat-specific files from that branch are applied to the release-next branch
  • The release-next branch is force pushed to the origin remote
  • The release-next branch is duplicated to release-next-ci
  • A timestamp file is added to release-next-ci branch
  • The release-next-ci branch is force pushed to the origin remote
  • A pull request is created (if it does not already exist) for this change, to trigger a CI run
  • OpenShift CI runs the upstream unit and integration tests on the PR

Mirroring releases from upstream release branches

Branches for specific versions may also be managed using this script by supplying a git-ref when running the script.

./redhat/release/update-to-head.sh v1.2.2

To mirror a release branch from upstream, a branch for our midstream changes must exist. The naming for this branch is in the form midstream-vX.Y.Z where vX.Y.Z corresponds to an upstream release branch. For example, to mirror, modify and test the upstream version v1.2.2 from your local laptop, you would take the following steps.

  1. Ensure the patch file from main and any other modifications we make in midstream cleanly applies on the upstream release branch. If it doesn't fix that first.
  2. Push a new branch based on our midstream main - e.g. git push origin main:midstream-v1.2.2
  3. Run ./redhat/release/update-to-head.sh v1.2.2, providing v1.2.2 as the upstream branch to mirror.

This will create a new "release" branch of the form redhat-vX.Y.Z, in this case redhat-v1.2.2 and a corresponding CI branch for testing, redhat-v1.2.2-ci. Then a PR is opened to apply these changes to the midstream release branch, redhat-v1.2.2. If OpenShift CI has been configured for this new branch, it will run the unit and integration tests from upstream on the PR.

Local configuration

To use this script locally, you'll need to have two git remotes for this repository.

  • upstream pointing to sigstream/rekor
  • origin pointing to securesign/rekor (this repo)

Example to mirror the upstream v1.2.2 release and kick off CI

git clone [email protected]:securesign/rekor.git
cd rekor
# Ensure that the patches cleanly apply
git push origin main:midstream-v1.2.2
# Add upstream as a remote
git remote add upstream [email protected]/sigstore/rekor.git
# Run the update script
./redhat/release/update-to-head.sh v1.2.2

This should create the redhat-v1.2.2 branch as well as a test branch at redhat-v1.2.2-ci, create a pull request, and initiate OpenShift CI.