Skip to content

Commit

Permalink
Polish update-antora-ui-spring action
Browse files Browse the repository at this point in the history
Improved README by adding an example when branches have a different antora file path
Fixed an error where the checkout step did not clone the right branch
  • Loading branch information
marcusdacoregio authored and rwinch committed May 20, 2024
1 parent 9ab6029 commit 17ed79e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,22 @@ permissions:
jobs:
update-antora-ui-spring:
runs-on: ubuntu-latest
name: Update Antora UI Spring
name: Update
strategy:
matrix:
branch: ['main', 'docs-build']
branch: [ '5.8.x', '6.1.x', '6.2.x', 'main' ]
steps:
- uses: spring-io/spring-docs-actions/update-antora-spring-ui@{ACTION_VERSION}
name: Update antora-playbook.yml
- uses: spring-io/spring-doc-actions/update-antora-spring-ui@{ACTION_VERSION}
name: Update on Supported Branches
with:
docs-branch: ${{ matrix.branch }}
token: ${{ secrets.GITHUB_TOKEN }}
antora-file-path: 'docs/antora-playbook.yml'
- uses: spring-io/spring-doc-actions/update-antora-spring-ui@{ACTION_VERSION}
name: Update on docs-build
with:
docs-branch: 'docs-build'
token: ${{ secrets.GITHUB_TOKEN }}
----

The PR will only be created if there is no open PR for the same branch, even if there is a newer version of Antora UI Spring.
Expand Down
2 changes: 2 additions & 0 deletions update-antora-spring-ui/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ runs:
using: "composite"
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.docs-branch }}
- id: generate-branch-name
name: Generate Branch Name
run: echo "branch-name=${{ inputs.docs-branch }}_${{ inputs.workflow-branch-suffix }}" >> $GITHUB_OUTPUT
Expand Down

0 comments on commit 17ed79e

Please sign in to comment.