Skip to content

Comments

ci: bundle Mkdocs site into Releases#41355

Merged
jamietanna merged 1 commit intomainfrom
ci/bundle-mkdocs
Feb 20, 2026
Merged

ci: bundle Mkdocs site into Releases#41355
jamietanna merged 1 commit intomainfrom
ci/bundle-mkdocs

Conversation

@jamietanna
Copy link
Contributor

@jamietanna jamietanna commented Feb 20, 2026

Changes

As we now perform the Mkdocs build as part of the main repo, we can
now attach the docs site build into the GitHub Release artifacts as part
of our release pipeline.

For folks who are running versions behind the "bleeding edge" of
Renovate, this is very useful, as they can now grab a copy of the built
documentation for their given Renovate version.

This allows folks to take the mkdocs-site.tgz and upload it to static
hosting, without restoring to workarounds0 that can make it more
difficult.

Because we're now building the docs site as part of the release, we need
to upload the built artifact to then be used by our deploy step.

As the deploy step no longer needs to build the docs site, we can
simplify this.

However, if the release hasn't occurred (because there are no commit(s)
that need a release right now) we still need to rebuild the docs site,
in case there are docs-only changes.

Context

Please select one of the below:

  • This closes an existing Issue: Closes #
  • This doesn't close an Issue, but I accept the risk that this PR may be closed if maintainers disagree with its opening or implementation

AI assistance disclosure

Did you use AI tools to create any part of this pull request?

Please select one option and, if yes, briefly describe how AI was used (e.g., code, tests, docs) and which tool(s) you used.

  • No — I did not use AI for this contribution.
  • Yes — minimal assistance (e.g., IDE autocomplete, small code completions, grammar fixes).
  • Yes — substantive assistance (AI generated non‑trivial portions of code, tests, or documentation).
  • Yes — other (please describe): Claude Sonnet 4.5 (GitHub Copilot + crush)

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

The public repository:

As we now perform the Mkdocs build as part of the main repo, we can
now attach the docs site build into the GitHub Release artifacts as part
of our release pipeline.

For folks who are running versions behind the "bleeding edge" of
Renovate, this is very useful, as they can now grab a copy of the built
documentation for their given Renovate version.

This allows folks to take the `mkdocs-site.tgz` and upload it to static
hosting, without restoring to workarounds[0] that can make it more
difficult.

Because we're now building the docs site as part of the release, we need
to upload the built artifact to then be used by our deploy step.

As the deploy step no longer needs to build the docs site, we can
simplify this.

However, if the release hasn't occurred (because there are no commit(s)
that need a release right now) we still need to rebuild the docs site,
in case there are docs-only changes.

[0]: https://www.jvt.me/posts/2024/11/19/renovate-private-docs/

Co-authored-by: Claude Sonnet 4.5 <jamie.tanna+github-copilot@mend.io>
@jamietanna jamietanna added ci:fulltest Run full test suite on all platforms and removed ci:fulltest Run full test suite on all platforms labels Feb 20, 2026
@jamietanna jamietanna marked this pull request as ready for review February 20, 2026 16:04
@jamietanna jamietanna requested a review from viceice February 20, 2026 16:04
@jamietanna jamietanna added this pull request to the merge queue Feb 20, 2026
Merged via the queue into main with commit 4a447ce Feb 20, 2026
45 checks passed
@jamietanna jamietanna deleted the ci/bundle-mkdocs branch February 20, 2026 16:19
@jamietanna
Copy link
Contributor Author

OK, let's give this a go - if it doesn't work we can revert

Worst case, we'll try a couple of attempts, and revert back before EOD today

@jamietanna
Copy link
Contributor Author

It's run in the case that no release is made (https://github.com/renovatebot/renovate/actions/runs/22231825236/job/64313402746) - I'll keep an eye on when a release is made

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants