Skip to content

Commit d71deb0

Browse files
mmulhollaMartin Mulholland
andauthored
Pull release docs from github for build purposes (#38)
Co-authored-by: Martin Mulholland <[email protected]>
1 parent 93ddde8 commit d71deb0

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,17 +101,18 @@ from the newly created ```v.2.0.x``` branch.
101101
version: '2.1.0'
102102
prerelease: -alpha
103103
```
104-
1. Modify `antora-playbook.yaml` to add content for the new release created:
104+
1. Modify `antora-playbook.yaml` to add content for the new release created (if not already covered by branch pattern ```v2.0.*```:
105105
```
106106
content:
107107
sources:
108108
- branches: HEAD
109109
start_path: docs
110110
url: ./
111-
- branches: v2.0.x
111+
- branches: [v2.*]
112112
start_path: docs
113-
url: ./
113+
url: https://github.com/devfile/docs
114114
```
115+
Note: pulling the release branches from github rather than locally is required for the docs build workflow.
115116
1. Build, test, commit and merge the changes
116117
117118

antora-playbook.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ content:
1414
- branches: HEAD
1515
start_path: docs
1616
url: ./
17-
- branches: v2.0.x
17+
- branches: [v2.*]
1818
start_path: docs
19-
url: ./
19+
url: https://github.com/devfile/docs
2020
output:
2121
destinations:
2222
- clean: true

0 commit comments

Comments
 (0)