Skip to content

Commit 28ff043

Browse files
committed
moves the action of commenting on the PR out of comment-on-pr into pr-url-and-dependent. updates contribute.md irt checks. removes common-on-pr workflow, no longer needed.
1 parent b8d3552 commit 28ff043

File tree

3 files changed

+12
-50
lines changed

3 files changed

+12
-50
lines changed

.github/workflows/comment-on-pr.yaml

-37
This file was deleted.

.github/workflows/pr-url-and-dependent.yaml

+8-11
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ jobs:
170170
state: '${{ steps.set-status-message.outputs.status_state }}'
171171

172172
report_changed_files:
173-
name: Collect a list of changed files
173+
name: Collects a list of changed files, reports their URL as a comment
174174
needs:
175175
- get_info_on_pr
176176
- get_pr_url
@@ -187,11 +187,10 @@ jobs:
187187
- uses: actions/checkout@v4
188188
with:
189189
fetch-depth: 0
190-
- name: Make artifact files
190+
- name: Make pr_comment.txt file
191191
run: |
192-
# these are used in comment-on-pr
193-
touch pr_number.txt pr_comment.txt
194-
echo "${{ env.PRNUM }}" > pr_number.txt
192+
# we need this for the later action
193+
touch pr_comment.txt
195194
- name: Get changed files
196195
id: changed-files
197196
uses: tj-actions/changed-files@v41
@@ -274,13 +273,11 @@ jobs:
274273
run: |
275274
echo -e "Your Platform.sh environment has successfully deployed. :rocket:\n\nSee the site:\n\n- [Platform.sh docs]($ENV_URL)\n- [Upsun docs]($UPSUN_ENV_URL)" > pr_comment.txt
276275
277-
- uses: actions/upload-artifact@v4
276+
- name: Post PR comment
277+
uses: marocchino/sticky-pull-request-comment@v2
278278
with:
279-
name: pr-comment-info
280-
path: |
281-
pr_comment.txt
282-
pr_number.txt
283-
retention-days: 1
279+
number: ${{ env.PRNUM }}
280+
path: pr_comment.txt
284281

285282
run-redirection-tests:
286283
name: Verify contracted redirections

CONTRIBUTING.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,10 @@ To ensure the docs work smoothly, a few checks run on each pull request:
175175
./bin/htmltest
176176
```
177177

178-
- Custom workflows [check all changed files](./.github/workflows/pr-url-and-dependent.yaml) within `docs/src`
179-
and [comment with links](./.github/workflows/comment-on-pr.yaml) to the deployed pages for review.
178+
- Custom workflows check all changed files within `docs/src`
179+
and comment with links to the deployed pages for review.
180+
- Checks redirection links that start with `/anchor`
181+
- Runs a series of end-to-end tests to ensure search is working properly
180182

181183
Outside of pull requests, twice a week [Muffet](https://github.com/raviqqe/muffet)
182184
checks if all links on the site are valid.

0 commit comments

Comments
 (0)