ci: new doc-preview workflow changes.#82
Conversation
ArekBalysNordic
force-pushed
the
ci_changes
branch
from
90e52a1 to
b4da044
Compare
Documentation PreviewThe documentation has been built successfully. You can view the preview here: preview Generated at: Expand to view changed pagesNo documentation files were changed in this PR.
|
| name: site-state | ||
| path: _site | ||
| retention-days: 14 # 2 weeks | ||
| retention-days: 7 # 1 week, every rebase updates the artifacts |
There was a problem hiding this comment.
Does it still work if old artifacts get deleted (e.g., after a week with no doc runs such as during a holiday period)? From a quick look it seems this workflow might not find the "existing pages" anymore.
By the way if you get fed up with gh-pages we could think about setting up something similar what we have in sdk-nrf / sdk-nrf-bm repos…
There was a problem hiding this comment.
Yes, the case is that all artefacts are deleted if there is no action in this repo within 7 days (or maybe let's leave it as it was - two weeks @edmont, what do you think?). If someone wants to see the docs preview again, a rebase is needed after this time. Yes, for now, gh-pages offers enough limits for us, so if we start running out of space there, we will need to move to something else.
There was a problem hiding this comment.
FYI in public repo it does not hurt to have more than 7 or 14 days here (action storage is free)
There was a problem hiding this comment.
Hmm, right, we need to care about the uploading content to the gh-pages due to limits. However, the state-site can be here much longer. Will set it to 1 month and add an appropriate note.
Added a functionality to take care of obsolete PR-previews removal to ensure that in the new PRs, there are no redundant ones. Since we have this mechanism, we do not need post-pr clean workflow because all the obsolete workflows will be deleted once a new PR is created or after 7 days. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
The doc preview note seems to be too long. Try to simplify it. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
Tigger doc-build workflows on changes in README.rst files in samples. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
The on_pr workflow only builds samples using Twister. If there is a change in doc-preview-related files, there is no need to run it. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
ArekBalysNordic
force-pushed
the
ci_changes
branch
from
b4da044 to
b1a5b9e
Compare
3 participants
samples.