Trigger documentation site rebuild after function release#1276
Conversation
✅ Deploy Preview for krm-function-catalog canceled.
|
There was a problem hiding this comment.
Pull request overview
This PR updates the release-tag GitHub Actions workflow to trigger a Netlify documentation site rebuild after a function release tag is pushed, ensuring the docs site refreshes cached GitHub API data used to render the function catalog.
Changes:
- Adds a post-release workflow step that POSTs to a Netlify build hook to force a rebuild with cleared cache.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
3e4875f to
f51f004
Compare
f51f004 to
a5a6e90
Compare
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
a5a6e90 to
6a981d5
Compare
Catalin-Stratulat-Ericsson
left a comment
There was a problem hiding this comment.
This is very nice. i wonder if we could also leverage something like this but for the porch documentation site so that the install version we give e.g. install version tag could be auto updated on every new release we make in the docs also as right now we have to manually update it and speaking of which we should propably do so considering it states to install 1.5.7 right now... porch install
Yes, this is feasible. we already have the building blocks in place across repositories. In kpt, we resolve the latest version from git tags https://github.com/kptdev/kpt/blob/main/documentation/Makefile#L19, and we can adapt the porch docs to follow the same pattern. |
Description
after-tag-with-version.yamlworkflow that triggers a Netlify documentation site rebuild after every function release tag push.resources.GetRemoteat build time. Since releases are created manually (via tag push), there was no mechanism to trigger a docs rebuild then the cached data remained stale indefinitely.{"clear_cache": true}, which triggers a fresh build with no cached remote resources.Why triggering per tag is safe
The
after-tag-with-version.yamlworkflow runs independently for each tag push. When usingmanual-patch-releasewithfunctions: "all", multiple tags are created in quick succession each triggering a separate Netlify build hook call.This is handled gracefully by Netlify's context queue: when multiple builds are triggered on the same site in an identical deploy context, they enter a context queue.
When the current build completes, only the newest enqueued build runs and all intermediate ones are skipped. So even if 10+ tags fire simultaneously, at most 2 actual builds occur (the one in progress + the latest queued). No wasted build minutes, no race conditions.
Related Issue(s)
Type of Change
Checklist
AI Disclosure
If so, please describe how:
- Kiro used for this PR message and analysis