Skip to content

Commit 03d87d2

Browse files
committed
docs(ci): add description/comment and clean up formatting in build-docs action
1 parent b3e6760 commit 03d87d2

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

.github/actions/build-docs/action.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
name: Build documents
2+
description: Bumps versions and builds the vue-press documentation site
23

34
inputs:
45
upload-artifact:
6+
description: Whether to upload the built site as a GitHub Pages artifact
57
default: true
68

79
runs:
@@ -13,6 +15,7 @@ runs:
1315
- name: Configure git user
1416
uses: ./.github/actions/config-git-user
1517

18+
# Applies pending changesets so docs build against the versions they'll ship with
1619
- name: Generate version
1720
shell: bash
1821
run: pnpm changeset version
@@ -28,4 +31,3 @@ runs:
2831
uses: actions/upload-pages-artifact@v4
2932
with:
3033
path: ./vue-press/dist
31-

0 commit comments

Comments
 (0)