Conversation
|
HTML artifacts: https://github.com/ros-infrastructure/rosindex/actions/runs/17469799301/artifacts/3929128965. To view the resulting site:
|
|
@rkent Hopefully this can make things easier for testing/reviewing content. It also found a bug in the dependencies that our test builds weren't even having any packages or repos discovered. |
|
I was confused by the word "artifacts" used in this PR. In rosindex, I've used "artifacts" to mean the items in the "_artifacts" folder, which are slowly-changing items that are prerequisites to the rendering. That's what I thought I was downloading. Maybe that just shows my inexperience so that the term "artifacts" did not have a broader meaning to me outside of how we've used it in rosindex. Anyway, I think the github-actions comment should be clearer that you are downloading the website for offline viewing. I'll make some proposed changes in code comments. The "bug in the dependencies" was intentional to make a test-build faster, but I can see that it only saves seconds and adding the prepare-sources dependency is on net an improvement. |
rkent
left a comment
rkent
left a comment
There was a problem hiding this comment.
Ok this LGTM with changing :"artifacts" to "site" in the automatic comment to use terminology that matches what is used by rosindex.
The automatic comment is a neat trick that I like, BTW.
| run: | | ||
| ./docker/run.sh make test-build No newline at end of file | ||
| ./docker/run.sh make test-build | ||
| - name: Upload document artifacts |
There was a problem hiding this comment.
maybe "upload rendered website"
.github/workflows/test_build.yaml
Outdated
| uses: actions/upload-artifact@v4 | ||
| id: artifact-upload-step | ||
| with: | ||
| name: html-artifacts-${{ github.event.pull_request.number }} |
.github/workflows/test_build.yaml
Outdated
| compression-level: 9 # maximum compression, default 6 | ||
| if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn` | ||
|
|
||
| - name: Find HTML artifacts link comment |
There was a problem hiding this comment.
"Find HTML site link comment"
.github/workflows/test_build.yaml
Outdated
| comment-author: 'github-actions[bot]' | ||
| body-includes: "HTML artifacts:" | ||
|
|
||
| - name: Create or update HTML artifacts link comment |
.github/workflows/test_build.yaml
Outdated
| comment-id: ${{ steps.find-comment.outputs.comment-id }} | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| body: | | ||
| HTML artifacts: ${{ steps.artifact-upload-step.outputs.artifact-url }}. |
.github/workflows/test_build.yaml
Outdated
| 1. Click on the above link to download the artifacts archive | ||
| 2. Extract it | ||
| 3. Run `ghrocker --devel html-artifacts-${{ github.event.pull_request.number }}` Requires ghrocker installed https://github.com/tfoote/ghrocker | ||
| 4. Open http://localhost:4000 in your favorite browser |
There was a problem hiding this comment.
Maybe add a line "Or just render the downloaded, extracted folder as a website using your favorite local rendering tool." This is not really dependent on ghrocker, it's just a website folder.
|
Site Test Render: https://github.com/ros-infrastructure/rosindex/actions/runs/17572376902/artifacts/3960851767. To view the resulting site:
|
|
Thanks I reworded most of those elements to make it hopefully clearer. |
2 participants
No description provided.