Skip to content

Commit 9a867df

Browse files
change all references to server branches to lose the v (#170)
1 parent 9ef66d2 commit 9a867df

File tree

6 files changed

+22
-22
lines changed

6 files changed

+22
-22
lines changed

.circleci/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ jobs:
6363
steps:
6464
- checkout
6565
- run:
66-
name: Fetch branches matching server-v*
66+
name: Fetch branches matching server-*
6767
command: |
68-
for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-v' | sed 's|refs/heads/||'); do
68+
for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-' | sed 's|refs/heads/||'); do
6969
echo "[INFO] Fetching branch: $branch"
7070
git checkout "$branch"
7171
git pull origin "$branch"

DEVELOPMENT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ The site will be available at `http://localhost:3000` by default.
8484
npm run build:docs
8585
```
8686

87-
- **Fetch server branches** (for server admin docs). You will need to have local copies of all server-v* branches to be able to build the full docs site locally:
87+
- **Fetch server branches** (for server admin docs). You will need to have local copies of all server-* branches to be able to build the full docs site locally:
8888
```bash
8989
npm run fetch-server-branches
9090
```
9191

92-
- **Force fetch server branches** if you want to force all your server-v* branches to the state of the upstream "current" versions, use the --force flag. This is recommended if you have no local changes on any server-v* branch:
92+
- **Force fetch server branches** if you want to force all your server-* branches to the state of the upstream "current" versions, use the --force flag. This is recommended if you have no local changes on any server-* branch:
9393

9494
```bash
9595
npm run fetch-server-branches --force
@@ -100,7 +100,7 @@ The site will be available at `http://localhost:3000` by default.
100100

101101
- `main` - Production-ready code
102102
- Feature branches - Named according to the feature being developed
103-
- Version branches - For version-specific documentation (e.g., `server-v4.1`)
103+
- Version branches - For version-specific documentation (e.g., `server-4.1`)
104104

105105
## Content Authoring
106106

@@ -255,9 +255,9 @@ When changes are made to the main branch to the build processes, the UI, or all
255255
1. Update local main branch
256256
2. Checkout a server branch
257257
3. Run `git rebase main`
258-
4. Push those changes with `git push --force-with-lease origin server-v4.1` - remember to use the correct server branch number.
258+
4. Push those changes with `git push --force-with-lease origin server-4.1` - remember to use the correct server branch number.
259259

260-
This should be done for every server-v* branch.
260+
This should be done for every server-* branch.
261261

262262
### Creating a New Component
263263

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This technical documentation consists of several specialized files:
4040
cd circleci-docs-static
4141
npm ci
4242
```
43-
2. **Make sure you've cloned server-v branches (Server Administration Docs)**
43+
2. **Make sure you've cloned server-* branches (Server Administration Docs)**
4444

4545
```bash
4646
npm run fetch-server-branches

antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ content:
1616
start_path: docs/orbs
1717
- url: .
1818
start_path: docs/server-admin
19-
branches: [server-v*]
19+
branches: [server-*]
2020
- url: .
2121
start_path: docs/contributors
2222
ui:

extensions/export-content-extension.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ function collectPages(contentCatalog, siteUrl) {
3939

4040
// Define which server-admin versions to exclude from indexing
4141
const excludedServerAdminVersions = [
42-
'server-v4.1',
43-
'server-v4.2',
44-
'server-v4.3',
45-
'server-v4.4',
46-
'server-v4.5',
47-
'server-v4.6',
48-
'server-v4.7'
42+
'server-4.1',
43+
'server-4.2',
44+
'server-4.3',
45+
'server-4.4',
46+
'server-4.5',
47+
'server-4.6',
48+
'server-4.7'
4949
];
5050

5151
contentCatalog.getComponents().forEach(({ name: comp, versions }) => {

scripts/fetch-server-branches.sh

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ set -e
44
# Parse command line arguments
55
FORCE_UPDATE=false
66
if [[ "$1" == "--force" || "$1" == "-f" ]]; then
7-
echo "[WARNING] Force update will discard any local changes on server-v* branches!"
8-
echo "[WARNING] This will reset all server-v* branches to exactly match origin."
7+
echo "[WARNING] Force update will discard any local changes on server-* branches!"
8+
echo "[WARNING] This will reset all server-* branches to exactly match origin."
99
read -p "Are you sure you want to continue? (y/N): " -n 1 -r
1010
echo
1111
if [[ $REPLY =~ ^[Yy]$ ]]; then
@@ -25,8 +25,8 @@ echo "[INFO] Current branch: $current_branch"
2525
echo "[INFO] Fetching remote branches..."
2626
git fetch origin
2727

28-
# Process all server-v* branches
29-
for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-v' | sed 's|refs/heads/||'); do
28+
# Process all server-* branches
29+
for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-' | sed 's|refs/heads/||'); do
3030
echo "[INFO] Updating branch: $branch"
3131
git checkout "$branch" 2>/dev/null || {
3232
echo "[INFO] Branch $branch doesn't exist locally, creating it..."
@@ -48,8 +48,8 @@ echo "[INFO] Returning to original branch: $current_branch"
4848
git checkout "$current_branch"
4949

5050
if [[ "$FORCE_UPDATE" == true ]]; then
51-
echo "[INFO] All server-v* branches have been force-updated to match origin"
51+
echo "[INFO] All server-* branches have been force-updated to match origin"
5252
else
53-
echo "[INFO] All server-v* branches have been updated"
53+
echo "[INFO] All server-* branches have been updated"
5454
echo "[INFO] Use --force or -f flag to force-update branches and avoid conflicts"
5555
fi

0 commit comments

Comments
 (0)