Skip to content

Conversation

@AnnsAnns
Copy link
Member

@AnnsAnns AnnsAnns commented Nov 27, 2025

Contribution description

I added the guide preview CI workflow we tested a few months ago. To enable it on a PR it needs to have the "CI: preview docs" label to prevent bad actors misusing this.

Since the PR Previews use a folder on the gh-pages branch, I also needed to change the the CI deployment action to a different one, since it didn't have support for excluding certain folders from the cleanup.

The doc related CI workflows were also the only ones that used 4 spaces, I fixed that formatting error.

Testing procedure

I uh, don't exactly know how best to test this working in our repository. It worked for my own blog but the environment is fairly different. Worst case this just fails, best case it works. Either way it shouldn't impact anything even if it breaks, (esp. since its guarded by the aforementioned label).

Issues/PRs references

@github-actions github-actions bot added Area: doc Area: Documentation Area: CI Area: Continuous Integration of RIOT components labels Nov 27, 2025
@AnnsAnns AnnsAnns added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs CI: preview docs Enables the docs preview for the PR. labels Nov 27, 2025
@riot-ci
Copy link

riot-ci commented Nov 27, 2025

Murdock results

✔️ PASSED

51cddf9 fix: use full path

Success Failures Total Runtime
1 0 1 01m:15s

Artifacts

@AnnsAnns
Copy link
Member Author

From searching for the error, it appears like there is a way to approve certain workflow runs on a per-PR basis which needs to be done here (the alternative would be to send secrets to fork CI workflows which probably isnt something that should be done on RIOT). Looking into it.

@crasbe crasbe added the Type: new feature The issue requests / The PR implemements a new feature for RIOT label Nov 27, 2025
@AnnsAnns
Copy link
Member Author

Yeah no, I'll report on the findings in tomorrows meeting but the TLDR is that this is not well translatable to the RIOT PR workflow without breaking some (very intentional) security checks Github has put into place. I tried integrating this into Murdock but Murdock is way too gigantic, complex and undocumented hard to understand as an outsider.

@AnnsAnns AnnsAnns closed this Nov 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: CI Area: Continuous Integration of RIOT components Area: doc Area: Documentation CI: preview docs Enables the docs preview for the PR. CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: new feature The issue requests / The PR implemements a new feature for RIOT

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants