-
Notifications
You must be signed in to change notification settings - Fork 0
ci: enhance pr site preview comment and add concurrency #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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,22 @@ | ||
| name: PR Preview & GitHub Pages Publish | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, closed] | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| permissions: | ||
| contents: write # gh-pages + cleanup | ||
| pull-requests: write # PR comments | ||
| pages: write # deploy-pages | ||
| id-token: write # required by deploy-pages | ||
| contents: write | ||
| pull-requests: write | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: pages-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build: | ||
| if: github.event.action != 'closed' | ||
|
|
@@ -39,7 +46,9 @@ jobs: | |
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: site | ||
| publish_branch: gh-pages | ||
| destination_dir: pr-${{ github.event.pull_request.number }} | ||
| keep_files: true | ||
|
|
||
| - name: Comment PR with preview URL | ||
| if: github.event_name == 'pull_request' | ||
|
|
@@ -48,15 +57,38 @@ jobs: | |
| script: | | ||
| const pr = context.payload.pull_request.number; | ||
| const { owner, repo } = context.repo; | ||
|
|
||
| const url = `https://ff4j.github.io/docs/pr-${pr}/`; | ||
| const marker = "<!-- pr-preview-comment -->"; | ||
|
|
||
| const body = `${marker} \n **Site preview available** 🔗 ${url}`; | ||
|
|
||
| await github.rest.issues.createComment({ | ||
| const { data: comments } = await github.rest.issues.listComments({ | ||
| owner, | ||
| repo, | ||
| issue_number: pr, | ||
| body: `📘 **Site preview available**:\n\n${url}` | ||
| }); | ||
|
|
||
| const existing = comments.find(comment => | ||
| comment.body?.includes(marker) | ||
| ); | ||
|
|
||
| if (existing) { | ||
| // Update existing comment | ||
| await github.rest.issues.updateComment({ | ||
| owner, | ||
| repo, | ||
| comment_id: existing.id, | ||
| body, | ||
| }); | ||
| } else { | ||
| // Create new comment | ||
| await github.rest.issues.createComment({ | ||
| owner, | ||
| repo, | ||
| issue_number: pr, | ||
| body, | ||
| }); | ||
| } | ||
|
|
||
| - name: Upload Pages artifact | ||
| if: github.event_name == 'push' | ||
|
|
@@ -76,8 +108,7 @@ jobs: | |
|
|
||
| cleanup: | ||
| if: github.event_name == 'pull_request' && | ||
| github.event.action == 'closed' && | ||
| github.event.pull_request.merged == false | ||
| github.event.action == 'closed' | ||
|
Comment on lines
110
to
+111
|
||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
|
|
@@ -88,7 +119,12 @@ jobs: | |
|
|
||
| - name: Remove PR preview folder | ||
| run: | | ||
| rm -rf pr-${{ github.event.pull_request.number }} | ||
| if [ -d "pr-${{ github.event.pull_request.number }}" ]; then | ||
| rm -rf pr-${{ github.event.pull_request.number }} | ||
| echo "Preview folder removed." | ||
| else | ||
| echo "Preview folder does not exist." | ||
| fi | ||
|
|
||
| - name: Commit cleanup | ||
| run: | | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issues.listCommentsis paginated (default 30). If a PR has more than one page of comments, the marker comment may not be found and this can create duplicate preview comments. Consider requesting a largerper_pageand/or paging through results (or using thepaginatehelper) before deciding whether to create vs update.