Skip to content

Commit ba3d8fe

Browse files
committed
docs(testing): document link-checker binary release process
Add comprehensive documentation for maintainers on how to: - Create releases in docs-tooling (automated) - Manually distribute binaries to docs-v2 (required for private repo) - Update workflow references when needed This addresses the missing process documentation for link-checker binary distribution between the two repositories.
1 parent 7d82d4e commit ba3d8fe

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

TESTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,47 @@ cargo build --release
171171
cp target/release/link-checker /usr/local/bin/
172172
```
173173

174+
#### Binary Release Process
175+
176+
**For maintainers:** To create a new link-checker release in docs-v2:
177+
178+
1. **Create release in docs-tooling** (builds and releases binary automatically):
179+
```bash
180+
cd docs-tooling
181+
git tag link-checker-v1.2.x
182+
git push origin link-checker-v1.2.x
183+
```
184+
185+
2. **Manually distribute to docs-v2** (required due to private repository access):
186+
```bash
187+
# Download binary from docs-tooling release
188+
curl -L -H "Authorization: Bearer $(gh auth token)" \
189+
-o link-checker-linux-x86_64 \
190+
"https://github.com/influxdata/docs-tooling/releases/download/link-checker-v1.2.x/link-checker-linux-x86_64"
191+
192+
curl -L -H "Authorization: Bearer $(gh auth token)" \
193+
-o checksums.txt \
194+
"https://github.com/influxdata/docs-tooling/releases/download/link-checker-v1.2.x/checksums.txt"
195+
196+
# Create docs-v2 release
197+
gh release create \
198+
--repo influxdata/docs-v2 \
199+
--title "Link Checker Binary v1.2.x" \
200+
--notes "Link validation tooling binary for docs-v2 GitHub Actions workflows." \
201+
link-checker-v1.2.x \
202+
link-checker-linux-x86_64 \
203+
checksums.txt
204+
```
205+
206+
3. **Update workflow reference** (if needed):
207+
```bash
208+
# Update .github/workflows/pr-link-check.yml line 98 to use new version
209+
sed -i 's/link-checker-v[0-9.]*/link-checker-v1.2.x/' .github/workflows/pr-link-check.yml
210+
```
211+
212+
> [!Note]
213+
> The manual distribution is required because docs-tooling is a private repository and the default GitHub token doesn't have cross-repository access for private repos.
214+
174215
#### Core Commands
175216

176217
```bash

0 commit comments

Comments
 (0)