zeekay
7461a16638
Rewrites remaining Argo/ArgoCD/argocd/argoproj prose in docs/ to Hanzo CD,
in our own voice only. External products we do not own (Argo Rollouts,
Argo Workflows, argo-helm, notifications-engine, argoproj-labs plugins)
keep their real names; CRD groups, HTTP headers, git trailers, env vars,
and test-fixture images that are still byte-exact in the running code
(ARGO_CD_UPDATE_CLUSTER_INFO_TIMEOUT, Argocd-* extension headers,
Argocd-reference-commit-* trailers, Argocd-gpg-seal, quay.io/argoprojlabs
cd-e2e-container) are left untouched.
Deletes docs/operator-manual/upgrading/1.0-1.1.md through 3.4-3.5.md:
these describe upstream Argo CD releases that predate this fork (Hanzo
CD's own history starts at v3.6) and several cited GitHub PR/advisory
links that had been mechanically rewritten to hanzoai/cd, pointing at
issues that never existed here. Deletes docs/developer-guide/dependencies.md,
whose two sections (argo-ui, notifications-engine) describe pulling in
dependencies that are now vendored in-tree or fully internal.
Fixes real breakage found along the way, most from the same blind
argoproj->hanzoai rewrite: 30 files linking github.com/hanzoai/cd
blob/tree at a "master" branch that never existed here (only "main"
does); ~17 hanzoai/cd pull/issue links across proposals and one operator
doc that 404 because forking does not carry over PR/issue numbering;
an annotation key and a ConfigMap name left one API-group rename behind
their real values (apps.hanzo.ai/*, cd-rbac-cm); a page rename
(Argo-CD-Integration.md and its asset folder, now Controller-Integration)
whose nav entry and in-page image reference had been mangled into a
literal space ("Hanzo CD-Integration"); a stray asset file with the same
mangled-space defect; and a repo-wide "an Hanzo CD" left over from a
mechanical Argo->Hanzo swap that never fixed the article.
mkdocs.yml: trims the Upgrading nav to the one real entry, drops
dependencies.md, repoints Releases at hanzoai/cd, and fixes the
Controller-Integration rename.
Verified with a strict mkdocs build (0 warnings) after the fixes above.
Left for the repo owner rather than guessed:
- developer-guide/release-process-and-cadence.md and
proposals/feature-bounties*.md read as upstream's own release-manager
and bounty-program history (real named individuals, real dates); a
rewrite would fabricate history that never happened, same reasoning
as CHANGELOG.md.
- assets/versions.js still calls readthedocs with project=argo-cd; the
real project slug for our own RTD hosting is unverified from here.
- signed-release-assets.md's cosign --certificate-identity-regexp still
names .github/workflows/image-reuse.yaml, which does not exist in this
repo (no .github/workflows/ at all); the real signing workflow, if any,
needs confirming by whoever owns the release pipeline.
- maintaining-internal-cd-forks.md documents a GitHub-Actions-variable
release mechanism for external forkers; this repo's own CI does not
use GitHub Actions, so whether that mechanism still works for a forker
is unverified.
2.0 KiB
Backporting Fixes
After submitting your PR and getting it merged, you might want to backport it to previous releases. The prerequisites for backporting are:
- Your PR is already merged into the
masterbranch - The changes are a bugfix
- The changes are non-breaking
- The backports are to actively supported releases
Automated Process
Adding a cherry-pick/x.y label to your PR (where x.y is the version you want to backport to e.g. 3.1) will
trigger the cherry pick workflow to open a PR against the targeted release branch. Anyone with commit access
can add the label, but a maintainer must merge the backport PR. If you cannot add the label yourself, ask the person who merged the PR to do it for
you.
Manual Process
Sometimes the automation fails, generally because the cherry-pick involves merge conflicts. In that case, you can manually create the backport PR. The process generally goes like this:
git checkout release-x.y
git pull origin release-x.y
git checkout -b backport-my-fix-to-x.y
git cherry-pick <commit hash of your bugfix's squash commit in master>
# Resolve any merge conflicts
git commit
git push <your fork> backport-my-fix-to-x.y
# Open a PR against release-x.y
Then repeat for the other release branches you want to backport to. Sometimes it's easier to cherry-pick the commit with resolved conflicts from the release branch after you've resolved them for the first backport rather than repeatedly resolving the same conflicts from the master branch for each backport. For example, after doing the steps above, do:
git rev-parse HEAD
# Note the commit hash
git checkout release-x.<y-1>
git pull origin release-x.<y-1>
git checkout -b backport-my-fix-to-x.<y-1>
git cherry-pick <commit hash from previous backport>
# Resolve any merge conflicts
git commit
git push <your fork> backport-my-fix-to-x.<y-1>
# Open a PR against release-x.<y-1>