Skip to content

ci(docs): retire release/3.4 docs deploy (moved to release/3.5) - #22063

Merged
AskAlexSharov merged 1 commit into
release/3.4from
docs/retire-r34-docs-deploy
Jul 7, 2026
Merged

ci(docs): retire release/3.4 docs deploy (moved to release/3.5)#22063
AskAlexSharov merged 1 commit into
release/3.4from
docs/retire-r34-docs-deploy

Conversation

@bloxster

Copy link
Copy Markdown
Collaborator

Companion to #22062.

The public docs site (docs.erigon.tech) now publishes from release/3.5, which carries its own docs-deploy.yml. This PR removes the docs-deploy.yml on release/3.4 so a future docs/site/** push to release/3.4 no longer redeploys and clobbers the v3.5 site (both used the shared github-pages environment).

Merge order

Merge this PR first, then #22062 (whose merge triggers the v3.5 deploy).

Note

This stops auto-deploys from release/3.4. Any further v3.4-only doc fixes should be applied on the new docs source branch (release/3.5) so they reach production.

🤖 Generated with Claude Code

The public docs site (docs.erigon.tech) now publishes from release/3.5,
which carries its own docs-deploy.yml. Removing this workflow so a push
to release/3.4 no longer redeploys and clobbers the v3.5 site (both used
the shared github-pages environment).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Retires the GitHub Pages docs deployment workflow on release/3.4 to prevent that branch from redeploying and overwriting the public docs site now intended to publish from release/3.5 (shared github-pages environment).

Changes:

  • Removes the release/3.4-triggered docs-deploy.yml workflow that built and deployed docs/site/** to GitHub Pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@AskAlexSharov
AskAlexSharov merged commit fbb7efd into release/3.4 Jul 7, 2026
24 checks passed
@AskAlexSharov
AskAlexSharov deleted the docs/retire-r34-docs-deploy branch July 7, 2026 06:08
rayjun pushed a commit to rayjun/erigon that referenced this pull request Jul 24, 2026
… cut (erigontech#22691)

## What

Adds an `archive-previous-docs-version` job to
`create-release-branch.yml` that runs right after a `release/N.N` branch
is cut and opens a **`docs`-labelled PR** archiving the previous stable
docs version onto the freshly-cut branch (Docusaurus native versioning).
A human reviews and merges that PR.

This automates **Q1** of the docs version transition (archive the
outgoing version). **Q2** — flipping the live deploy on docs.erigon.tech
to the new series — is intentionally left as the existing manual
retire+publish pair (erigontech#22062 / erigontech#22063).

## Why

Versioning is not automatic today: cutting `release/3.6` leaves
`versions.json` without a `v3.5` snapshot, so the previous stable
version would silently drop out of the version dropdown. Doing it by
hand is easy to forget or get wrong.

## How it works

- **Sources the snapshot from the OUTGOING release branch**
(`release/N.<M-1>`), not the just-cut branch — which was cut from `main`
and already holds the *next* version's docs. (This is the correctness
bug the manual `docs-version-bump.yml` path is prone to.)
- **Ports the outgoing branch's full versioned state** (`versions.json`
+ all `versioned_docs/` + `versioned_sidebars/`) plus the fresh
snapshot, then enforces the 3-archived-version cap — so no older version
drops off at the *next* cut.
- **Fail-closed series selection**: enumerates `release/N.N` branches
via the GitHub API, exact regex (excludes patch-style names like
`release/3.0.10`), numeric per-component sort (so `3.10 > 3.9`); aborts
on API error rather than guessing.
- **Build-verified before opening** (`onBrokenLinks: throw`), llms.txt
regenerated.
- **`dry_run`** validates the full port + build without opening a PR.
- Opens the PR with the default `GITHUB_TOKEN` (scoped `contents:write`
+ `pull-requests:write`) for manual review/merge. Note: a
`GITHUB_TOKEN`-opened PR does not itself trigger `pull_request` CI
(Actions recursion guard); the archive is already build-verified in-job,
and a reviewer merges after inspecting the diff.

## Notes for reviewers

- The version chain stays intact only if each cycle's archive PR is
merged into its release branch before the next cut (inherent to the
human-merge model; no worse than today's fully-manual state).
- Passed `actionlint` (with shellcheck) and `zizmor` locally.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Bloxster <gianni.morselli@erigon.tech>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
bloxster added a commit that referenced this pull request Aug 3, 2026
… cut (#22691)

## What

Adds an `archive-previous-docs-version` job to
`create-release-branch.yml` that runs right after a `release/N.N` branch
is cut and opens a **`docs`-labelled PR** archiving the previous stable
docs version onto the freshly-cut branch (Docusaurus native versioning).
A human reviews and merges that PR.

This automates **Q1** of the docs version transition (archive the
outgoing version). **Q2** — flipping the live deploy on docs.erigon.tech
to the new series — is intentionally left as the existing manual
retire+publish pair (#22062 / #22063).

## Why

Versioning is not automatic today: cutting `release/3.6` leaves
`versions.json` without a `v3.5` snapshot, so the previous stable
version would silently drop out of the version dropdown. Doing it by
hand is easy to forget or get wrong.

## How it works

- **Sources the snapshot from the OUTGOING release branch**
(`release/N.<M-1>`), not the just-cut branch — which was cut from `main`
and already holds the *next* version's docs. (This is the correctness
bug the manual `docs-version-bump.yml` path is prone to.)
- **Ports the outgoing branch's full versioned state** (`versions.json`
+ all `versioned_docs/` + `versioned_sidebars/`) plus the fresh
snapshot, then enforces the 3-archived-version cap — so no older version
drops off at the *next* cut.
- **Fail-closed series selection**: enumerates `release/N.N` branches
via the GitHub API, exact regex (excludes patch-style names like
`release/3.0.10`), numeric per-component sort (so `3.10 > 3.9`); aborts
on API error rather than guessing.
- **Build-verified before opening** (`onBrokenLinks: throw`), llms.txt
regenerated.
- **`dry_run`** validates the full port + build without opening a PR.
- Opens the PR with the default `GITHUB_TOKEN` (scoped `contents:write`
+ `pull-requests:write`) for manual review/merge. Note: a
`GITHUB_TOKEN`-opened PR does not itself trigger `pull_request` CI
(Actions recursion guard); the archive is already build-verified in-job,
and a reviewer merges after inspecting the diff.

## Notes for reviewers

- The version chain stays intact only if each cycle's archive PR is
merged into its release branch before the next cut (inherent to the
human-merge model; no worse than today's fully-manual state).
- Passed `actionlint` (with shellcheck) and `zizmor` locally.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Bloxster <gianni.morselli@erigon.tech>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
(cherry picked from commit a18ea1c)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants