summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-10 15:33:09 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-10 15:33:32 +0300
commit8dbf8b052075b0fb7af38b7b505260e4f673a998 (patch)
tree7f2558f730e1ae39d0eb8203a6e7ad6765f895e6
parent1a1aacfe67699ab468fbb5672d9610af80dabc76 (diff)
downloadvyos-documentation-8dbf8b052075b0fb7af38b7b505260e4f673a998.tar.gz
vyos-documentation-8dbf8b052075b0fb7af38b7b505260e4f673a998.zip
ci/docs: drop current branch references after rename to rolling
Cleanup PR following the current→rolling default-branch rename. Drops the now-stale current branch from workflow triggers, flips remaining defaults, and updates documentation/templates. Workflows: - pr-mirror-repo-sync.yml: branches narrowed to [rolling]; workflow_dispatch default and choice list now rolling-only; sync_branch fallback flipped from 'current' to 'rolling'. - check-open-prs-conflict.yml: dropped current from push.branches. - update-version-tags.yml: dropped current from push.branches and from the case statement (now bare 'rolling) TAG=rolling'). - submodules.yml: renamed update_current job, branch update-dependencies-current, and the related commit/title strings to rolling. - update-translations.yml: PR branch update-translations-current renamed to update-translations-rolling. - ai-validation.yml: prompt example updated. Docs/templates: - docs/conf.py: READTHEDOCS_GIT_IDENTIFIER fallback flipped to 'rolling'; comment block updated to describe the rolling branch (the user-facing "(current)" suffix is release-channel terminology and remains). - README.md: branching-scheme section now describes rolling as the default branch, with a note about the rename date. - .github/PULL_REQUEST_TEMPLATE.md: CONTRIBUTING link points at blob/rolling. External @current refs to vyos/.github and vyos/vyos-cla-signatures are left untouched — they reference those repos' default branches and are unaffected by this repo's rename. 🤖 Generated by [robots](https://vyos.io)
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md2
-rw-r--r--.github/workflows/ai-validation.yml2
-rw-r--r--.github/workflows/check-open-prs-conflict.yml1
-rw-r--r--.github/workflows/pr-mirror-repo-sync.yml11
-rw-r--r--.github/workflows/submodules.yml8
-rw-r--r--.github/workflows/update-translations.yml2
-rw-r--r--.github/workflows/update-version-tags.yml3
-rw-r--r--README.md6
-rw-r--r--docs/conf.py10
9 files changed, 22 insertions, 23 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 2c1dd640..61a1c45e 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -19,4 +19,4 @@
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] I have read the [**CONTRIBUTING**](https://github.com/vyos/vyos-documentation/blob/current/CONTRIBUTING.md) document \ No newline at end of file
+- [ ] I have read the [**CONTRIBUTING**](https://github.com/vyos/vyos-documentation/blob/rolling/CONTRIBUTING.md) document \ No newline at end of file
diff --git a/.github/workflows/ai-validation.yml b/.github/workflows/ai-validation.yml
index a5d120e7..60964396 100644
--- a/.github/workflows/ai-validation.yml
+++ b/.github/workflows/ai-validation.yml
@@ -150,7 +150,7 @@ jobs:
IMPORTANT: This PR targets the **${{ steps.branch.outputs.target }}** branch.
The vyos-1x checkout matches this branch. Features may differ between branches
- (e.g., a command exists in `current` but not in `sagitta`). Only flag issues
+ (e.g., a command exists in `rolling` but not in `sagitta`). Only flag issues
relevant to this specific branch.
## Pass 1 Findings
diff --git a/.github/workflows/check-open-prs-conflict.yml b/.github/workflows/check-open-prs-conflict.yml
index 3aa9ce05..9667fd62 100644
--- a/.github/workflows/check-open-prs-conflict.yml
+++ b/.github/workflows/check-open-prs-conflict.yml
@@ -2,7 +2,6 @@ name: "Open PRs Conflicts checker"
on:
push:
branches:
- - current
- rolling
- sagitta
- circinus
diff --git a/.github/workflows/pr-mirror-repo-sync.yml b/.github/workflows/pr-mirror-repo-sync.yml
index 1f01bd02..5c944971 100644
--- a/.github/workflows/pr-mirror-repo-sync.yml
+++ b/.github/workflows/pr-mirror-repo-sync.yml
@@ -3,16 +3,15 @@ name: PR Mirror and Repo Sync
on:
pull_request_target:
types: [closed]
- branches: [current, rolling]
+ branches: [rolling]
workflow_dispatch:
inputs:
sync_branch:
description: 'Branch to mirror'
required: true
- default: 'current'
+ default: 'rolling'
type: choice
options:
- - current
- rolling
permissions:
@@ -28,9 +27,9 @@ jobs:
github.event_name == 'workflow_dispatch' ||
(github.event_name == 'pull_request_target' && github.event.pull_request.merged == true)
)
- uses: vyos/.github/.github/workflows/pr-mirror-repo-sync.yml@current
- with:
- sync_branch: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.base.ref || github.event.inputs.sync_branch || 'current' }}
+ uses: vyos/.github/.github/workflows/pr-mirror-repo-sync.yml@current
+ with:
+ sync_branch: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.base.ref || github.event.inputs.sync_branch || 'rolling' }}
secrets:
PAT: ${{ secrets.PAT }}
REMOTE_OWNER: ${{ secrets.REMOTE_OWNER }}
diff --git a/.github/workflows/submodules.yml b/.github/workflows/submodules.yml
index 24b6c505..bb93b93f 100644
--- a/.github/workflows/submodules.yml
+++ b/.github/workflows/submodules.yml
@@ -5,7 +5,7 @@ on:
# 06:00 UTC on Monday
- cron: '0 6 * * 1'
jobs:
- update_current:
+ update_rolling:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
@@ -31,12 +31,12 @@ jobs:
uses: peter-evans/create-pull-request@v6
with:
token: ${{ secrets.PR_ACTION_DOCUMENTATION_SUBMODULE_UPDATE }}
- commit-message: "Github: update current branch"
- title: "Github: update current branch"
+ commit-message: "Github: update rolling branch"
+ title: "Github: update rolling branch"
body: |
Autoupdate vyos-1x submodule
update releasenotes
- branch: update-dependencies-current
+ branch: update-dependencies-rolling
delete-branch: true
update_sagitta:
diff --git a/.github/workflows/update-translations.yml b/.github/workflows/update-translations.yml
index 6ab53323..4b0bafa1 100644
--- a/.github/workflows/update-translations.yml
+++ b/.github/workflows/update-translations.yml
@@ -57,6 +57,6 @@ jobs:
title: "Github: update translations"
body: |
Generate, upload new and download translation files
- branch: update-translations-current
+ branch: update-translations-rolling
delete-branch: true
diff --git a/.github/workflows/update-version-tags.yml b/.github/workflows/update-version-tags.yml
index c7c372a3..7f179586 100644
--- a/.github/workflows/update-version-tags.yml
+++ b/.github/workflows/update-version-tags.yml
@@ -3,7 +3,6 @@ name: Update version tags
on:
push:
branches:
- - current
- rolling
- circinus
- sagitta
@@ -28,7 +27,7 @@ jobs:
run: |
set -euo pipefail
case "$BRANCH" in
- current|rolling) TAG=rolling ;;
+ rolling) TAG=rolling ;;
circinus) TAG=1.5 ;;
sagitta) TAG=1.4 ;;
*) echo "Unexpected branch: $BRANCH" >&2; exit 1 ;;
diff --git a/README.md b/README.md
index 46f0b20d..8f8bb674 100644
--- a/README.md
+++ b/README.md
@@ -11,10 +11,10 @@ Our old wiki with documentation from the VyOS 1.1.x and early 1.2.0 era can stil
Our documentation repository follows the same branching scheme as the VyOS source itself.
We maintain one documentation branch per VyOS release.
-The default branch that contains the most recent VyOS documentation is called `current`
-and matches the latest VyOS rolling release.
+The default branch that contains the most recent VyOS documentation is called `rolling`
+(renamed from `current` on 2026-05-10) and matches the latest VyOS rolling release.
-All new documentation enhancements go to the `current` branch. If those changes
+All new documentation enhancements go to the `rolling` branch. If those changes
are beneficial for previous VyOS documentation versions they will be
cherry-picked to the appropriate branch(es).
diff --git a/docs/conf.py b/docs/conf.py
index 083482a8..ea3c5b61 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -29,12 +29,14 @@ author = u'VyOS maintainers and contributors'
# The short X.Y version (rolling — next major; bumped at branch cut)
version = u'rolling'
-# The full version, including alpha/beta/rc tags. The `current` branch
+# The full version, including alpha/beta/rc tags. The `rolling` branch
# is the rolling tip and serves at /en/rolling/ on RTD; the literal
# below is exposed in the page footer ("v: rolling (current)") and is
# interpolated into _templates/llms.txt.j2 ("This documentation covers
# {{ release }}."). Pin this to a value that names what the rolling
-# docs actually serve, not a stale LTS codename.
+# docs actually serve, not a stale LTS codename. The "(current)" suffix
+# is release-channel terminology for the current rolling release; it is
+# unrelated to the former branch name.
release = u'rolling (current)'
# -- General configuration ---------------------------------------------------
@@ -136,9 +138,9 @@ html_baseurl = 'https://docs.vyos.io/en/rolling/'
_rtd_version_type = os.environ.get('READTHEDOCS_VERSION_TYPE', '')
_github_version = (
- os.environ.get('READTHEDOCS_GIT_COMMIT_HASH', 'current')
+ os.environ.get('READTHEDOCS_GIT_COMMIT_HASH', 'rolling')
if _rtd_version_type == 'external'
- else os.environ.get('READTHEDOCS_GIT_IDENTIFIER', 'current')
+ else os.environ.get('READTHEDOCS_GIT_IDENTIFIER', 'rolling')
)
html_context = {