Skip to content

Commit fc76fb9

Browse files
committed
restructure for clarity
1 parent c1e0a55 commit fc76fb9

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

fern/products/docs/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ navigation:
251251
- section: Developer tools
252252
collapsed: true
253253
contents:
254-
- page: Orchestrate GitHub Releases
254+
- page: Orchestrate GitHub releases
255255
path: ./pages/developer-tools/orchestrate-docs-releases.mdx
256256
- page: Cursor
257257
path: ./pages/developer-tools/cursor.mdx

fern/products/docs/pages/developer-tools/orchestrate-docs-releases.mdx

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
---
22
title: Orchestrate releases
3-
description: Coordinate the updates of your docs across multiple repositories and releases.
3+
description: Coordinate documentation updates across multiple repositories and releases.
44
---
55

6-
Fern Docs supports orchestrating the release of your docs based on releases from other repositories. This is useful when you are documenting features that depend on other features that are released in other repositories.
6+
Fern Docs supports orchestrating documentation releases based on releases from other repositories. This is useful when documenting features that depend on releases in other repositories.
77

8-
## Trigger a dispatch for a specific release tag
8+
This requires two GitHub Actions: one in the feature repository and one in the documentation repository.
99

10-
Add the following GitHub Action workflow to the repository where the releases will be made.
10+
<Steps>
11+
<Step title="Set up release notification in the feature repository">
1112

12-
```yml
13+
Add this GitHub Action workflow to the repository where features are released. When a new release is created with the specified tag pattern, this workflow will send a notification to your documentation repository, triggering the auto-merge process.
14+
15+
Replace the following placeholders with your own values:
16+
- `<GITHUB_ACCESS_TOKEN>`: GitHub token with `repo` scope
17+
- `<ORG>`: Organization containing the docs repository
18+
- `<DOCS_REPO>`: Docs repository name
19+
- `<PRODUCT_RELEASE_TAG>`: Product release tag
20+
21+
```yml title=".github/workflows/notify-docs-repo.yml"
1322
name: Notify Docs Repo
1423
on:
1524
release:
@@ -30,17 +39,12 @@ jobs:
3039
-d '{"event_type":"<PRODUCT_RELEASE_TAG>","client_payload":{"version":"${{ github.ref_name }}"}}'
3140
```
3241
33-
<Note title="Replace placeholders with your own values">
34-
- `<GITHUB_ACCESS_TOKEN>`: A GitHub access token with the `repo` scope.
35-
- `<ORG>`: The organization that contains the docs repository.
36-
- `<DOCS_REPO>`: The name of the docs repository.
37-
- `<PRODUCT_RELEASE_TAG>`: The tag of the product release.
38-
</Note>
42+
</Step>
43+
<Step title="Configure auto-merge in the documentation repository">
3944
40-
## Merge dependent PRs
45+
Add this GitHub Action workflow to your documentation repository to auto-merge PRs when features are released. Replace `<PRODUCT_RELEASE_TAG>` with your product release tag.
4146

42-
```yml
43-
# .github/workflows/auto-merge-on-release.yml in docs repo
47+
```yml title=".github/workflows/auto-merge-on-release.yml"
4448
name: Auto-merge on Docs Release
4549
on:
4650
repository_dispatch:
@@ -69,7 +73,7 @@ jobs:
6973
const hasVersionLabel = labels.includes(`depends-on: <PRODUCT_RELEASE_TAG>@${version}`);
7074

7175
if (hasLatestLabel || hasVersionLabel) {
72-
// Check if PR is approved and CI passes
76+
// Check if PR is approved
7377
const { data: reviews } = await github.rest.pulls.listReviews({
7478
owner: context.repo.owner,
7579
repo: context.repo.repo,
@@ -91,7 +95,5 @@ jobs:
9195
}
9296
}
9397
```
94-
95-
<Note title="Replace placeholders with your own values">
96-
- `<PRODUCT_RELEASE_TAG>`: The tag of the product release.
97-
</Note>
98+
</Step>
99+
</Steps>

0 commit comments

Comments
 (0)