Skip to content

Commit 2da7fb6

Browse files
committed
Create draft release, build docs on draft publish (#2584)
<!-- Reference any GitHub issues resolved by this PR --> Closes # ## Introduced changes <!-- A brief description of the changes --> - Instead of immediately publishing docs and release, create a draft release. Publish docs on draft publication. ## Checklist <!-- Make sure all of these are complete --> - [x] Linked relevant issue - [x] Updated relevant documentation - [x] Added relevant tests - [x] Performed self-review of the code - [x] Added changes to `CHANGELOG.md`
1 parent 4472f34 commit 2da7fb6

File tree

2 files changed

+5
-10
lines changed

2 files changed

+5
-10
lines changed

.github/workflows/docs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ on:
99
# Allows you to run this workflow manually from the Actions tab
1010
workflow_dispatch:
1111

12+
release:
13+
types:
14+
- released
15+
1216
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
1317
permissions:
1418
contents: read

.github/workflows/release.yml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ jobs:
237237
uses: taiki-e/create-gh-release-action@72d65cee1f8033ef0c8b5d79eaf0c45c7c578ce3
238238
with:
239239
token: ${{ secrets.GITHUB_TOKEN }}
240+
draft: true
240241
changelog: CHANGELOG.md
241242
allow-missing-changelog: false
242243
title: $version
@@ -248,13 +249,3 @@ jobs:
248249
env:
249250
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
250251
TAG: ${{ steps.create-release.outputs.computed-prefix }}${{ steps.create-release.outputs.version }}
251-
252-
deploy-docs:
253-
name: Deploy documentation
254-
needs: [ create-release, verify-version ]
255-
permissions:
256-
contents: read
257-
pages: write
258-
id-token: write
259-
if: ${{ !contains(needs.verify-version.outputs.version, '-') }}
260-
uses: ./.github/workflows/docs.yml

0 commit comments

Comments
 (0)