Skip to content

🐛 Use different GH action to properly clean up preview branches #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 18, 2024
Merged

🐛 Use different GH action to properly clean up preview branches #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 16 additions & 14 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ env:
jobs:
build_site:
name: "Build site with Antora"
runs-on: [ubuntu-24.04]
runs-on: [ubuntu-22.04]
steps:
- name: Checkout
uses: actions/checkout@v4
Expand All @@ -35,7 +35,7 @@ jobs:
pull-requests: write
repository-projects: write
id-token: write
runs-on: [ubuntu-24.04]
runs-on: [ubuntu-22.04]
needs: [build_site]
name: "Deploy GitHub Pages"
if: github.event_name != 'pull_request'
Expand All @@ -48,12 +48,13 @@ jobs:
name: site
path: "${{ github.workspace }}/${{ env.SITE_DIR }}"
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
uses: peaceiris/actions-gh-pages@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: "${{ env.SITE_DIR }}"
commit-message: "[CI] Publish Documentation for ${{ github.sha }}"
clean: false
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: "${{ env.SITE_DIR }}"
commit_message: "[CI] Publish Documentation for ${{ github.sha }}"
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'

# Based on : https://daiyi.co/blog/pr-previews-for-github-pages/
deploy_preview:
Expand All @@ -64,7 +65,7 @@ jobs:
id-token: write
env:
PR_PATH: pull-${{ github.event.number }}
runs-on: [ ubuntu-24.04 ]
runs-on: [ ubuntu-22.04 ]
needs: [ build_site ]
name: "Deploy preview for PR"
if: github.event_name == 'pull_request'
Expand All @@ -90,13 +91,14 @@ jobs:
path: "${{ github.workspace }}/${{ env.SITE_DIR }}"

- name: Deploy PR preview
uses: JamesIves/github-pages-deploy-action@v4
uses: peaceiris/actions-gh-pages@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: "${{ env.SITE_DIR }}"
target-folder: "${{ env.PR_PATH }}"
commit-message: "[CI] Publish Preview for PR #${{ github.event.number }}"
clean: false
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: "${{ env.SITE_DIR }}"
destination_dir: "${{ env.PR_PATH }}"
commit_message: "[CI] Publish Preview for PR #${{ github.event.number }}"
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'

- name: Update comment
uses: hasura/comment-progress@v2.3.0
Expand Down
13 changes: 7 additions & 6 deletions .github/workflows/pr-close.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@ jobs:
run: "mkdir -p ${{ env.SITE_DIR }}"

- name: Removing PR preview
uses: JamesIves/github-pages-deploy-action@v4
uses: peaceiris/actions-gh-pages@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: "${{ env.SITE_DIR }}"
target-folder: "${{ env.PR_PATH }}"
commit-message: "[CI] Delete Preview for PR #${{ github.event.number }}"
clean: false
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: "${{ env.SITE_DIR }}"
destination_dir: "${{ env.PR_PATH }}"
commit_message: "[CI] Delete Preview for PR #${{ github.event.number }}"
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'

- name: Comment on PR
uses: hasura/comment-progress@v2.3.0
Expand Down