Skip to content

Commit

Permalink
Deploy plugin docs to GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
timtebeek committed Jul 27, 2023
1 parent 3313bbf commit c97db1b
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 1 deletion.
47 changes: 47 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy plugin docs to Pages

#TODO Limit to tags such that we don't deploy on every push
#on:
# push:
# tags:
# - v*

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
pages:
environment:
name: github-pages
url: ${{steps.deployment.outputs.page_url}}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: gradle/wrapper-validation-action@v1
- uses: actions/[email protected]
with:
distribution: temurin
java-version: 17
cache: maven
- name: site
run: ./mvnw --show-version --no-transfer-progress --update-snapshots clean site --file=pom.xml --fail-at-end --batch-mode -Dstyle.color=always -Ddependency-check.skip=true
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: target/site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<maven>3.3.1</maven>
</prerequisites>

<url>https://github.com/openrewrite/rewrite-maven-plugin</url>
<url>https://openrewrite.github.io/rewrite-maven-plugin/</url>

<licenses>
<license>
Expand Down

0 comments on commit c97db1b

Please sign in to comment.