Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-generate-html.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "Generate HTML"
run-name: "Generate ${{ inputs.publish-env }} HTML from ${{ github.ref_name }}"
run-name: "Generate HTML from ${{ github.ref_name }} for ${{ inputs.publish-env }}"

permissions:
contents: read
Expand Down
14 changes: 10 additions & 4 deletions .github/workflows/docs-generate-pdf.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "Generate PDF"
run-name: "Generate ${{ inputs.publish-env }} PDF from ${{ github.ref_name }}"
run-name: "Generate PDF from ${{ inputs.build-ref || github.ref_name }} for ${{ inputs.publish-env }}"

permissions:
contents: read
Expand All @@ -11,8 +11,9 @@ permissions:
# way: there's no docs-verify step (no equivalent check exists yet for a PDF), and
# build/publish are two plain jobs rather than a reusable-workflow call plus a verify call.
#
# No build-ref input - see docs-generate-html.yml's own comment on why: the git ref to
# build from is always whatever ref this run was itself dispatched against.
# The optional build-ref input is the branch to build, for the PDF of a version branch: the
# trigger dispatches this from the dev or prod branch (the branch docs-publish checks) with the
# version branch in build-ref. Blank builds the branch this run is on.
#
# Do not run this by hand. It has a workflow_dispatch trigger only because the API call that
# starts it needs one, and it must run as its own run so that its head_branch is the branch
Expand All @@ -30,14 +31,19 @@ on:
options:
- dev
- prod
build-ref:
description: "The branch to build. Leave blank to build the branch this workflow runs on."
type: string
required: false
default: ''

jobs:

docs-build-pdf:
name: Generate PDF
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pdf-build.yml@v2
with:
build-ref: ${{ github.ref_name }}
build-ref: ${{ inputs.build-ref || github.ref_name }}
fetch-depth: 0
publish-env: ${{ inputs.publish-env }}

Expand Down
Loading