You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/docs/pages/developer-tools/orchestrate-docs-releases.mdx
+21-19Lines changed: 21 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,24 @@
1
1
---
2
2
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.
4
4
---
5
5
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.
7
7
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.
9
9
10
-
Add the following GitHub Action workflow to the repository where the releases will be made.
10
+
<Steps>
11
+
<Steptitle="Set up release notification in the feature repository">
11
12
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
<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">
39
44
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.
41
46
42
-
```yml
43
-
# .github/workflows/auto-merge-on-release.yml in docs repo
0 commit comments