Skip to content

Commit a697679

Browse files
authored
chore: Do not publish docs on maintenance branch. (#380)
This PR is to prevent 8.x docs from overwriting 9.x docs. In the future we may want to consider docs for multiple versions, but we do not currently support that.
1 parent 4c6b43c commit a697679

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

.github/workflows/release-please.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,5 @@ jobs:
3636
with:
3737
workspace_path: packages/sdk/server-node
3838
aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
39+
# Only publish docs on the default branch.
40+
publish_docs: ${{ github.ref_name == github.event.repository.default_branch }}

actions/full-release/action.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ inputs:
77
aws_assume_role:
88
description: 'The ARN of an AWS IAM role to assume. Used to auth with AWS to upload results to S3.'
99
required: true
10+
publish_docs: # This is useful for previous major versions to avoid overwriting current docs.
11+
description: 'Should this release publish documentation?'
12+
required: false
13+
default: 'true'
1014

1115
runs:
1216
using: composite
@@ -37,5 +41,6 @@ runs:
3741
prerelease: false
3842
dry_run: false
3943
- uses: ./actions/publish-docs
44+
if: ${{ inputs.publish_docs == 'true' }}
4045
with:
4146
workspace_path: ${{ inputs.workspace_path }}

0 commit comments

Comments
 (0)