Skip to content

Add weekly scheduled workflow to rebuild docs site#3110

Open
larainema wants to merge 1 commit intokubernetes-sigs:mainfrom
larainema:ci/periodic-docs-build
Open

Add weekly scheduled workflow to rebuild docs site#3110
larainema wants to merge 1 commit intokubernetes-sigs:mainfrom
larainema:ci/periodic-docs-build

Conversation

@larainema
Copy link
Copy Markdown
Contributor

@larainema larainema commented Apr 9, 2026

What problem does this PR solve?

The docs site at https://cluster-api-openstack.sigs.k8s.io embeds content from external repositories using mdbook-embed. For example, the getting-started page is embedded directly from CAPI.

Since the site is deployed via Netlify and only rebuilds on push to main, the embedded external content becomes stale if no PRs are merged for some time.

Fixes #2811

Solution

Add a weekly scheduled GitHub Actions workflow that triggers a Netlify build via a build hook. This Add a weekly scheduled GitHub Actions workflow that triggers a Netlify build via a [build hook](https://docs.netlify.com/conmmits.

The workflow also supports workflow_dispatch for manual triggering.

Setup required by maintainers

After merging, a maintainer with Netlify access needs to:

  1. Create a **1. Create a **1. Create a **1. Create a **Build & deploy > Build hooks_ (name it e.g. weekly-docs-rebuild)
  2. Add the hook URL as a GitHub Actions secret named NETLIFY_BUILD_HOOK

@larainema
Add weekly scheduled workflow to rebuild docs site
b936b68 
The docs site embeds content from external repositories (e.g. the
getting-started page is embedded from CAPI). This embedded content
only updates when Netlify rebuilds the site, which only happens on
push to main. If no PRs are merged for a while, the embedded content
becomes stale.

Add a weekly scheduled GitHub Actions workflow that triggers a Netlify
build via a build hook. This ensures the docs site always has the
latest content from embedded external sources.

Maintainers need to:
1. Create a build hook in Netlify (Site settings > Build & deploy >
   Build hooks)
2. Add the hook URL as a GitHub Actions secret named NETLIFY_BUILD_HOOK

Signed-off-by: Dong Ma <winterma.dong@gmail.com>
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Apr 9, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign neolit123 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 9, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Apr 9, 2026

Hi @larainema. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 9, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 9, 2026 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

Name Link
🔨 Latest commit b936b68
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sigs-cluster-api-openstack/deploys/69d797471efcbb0008b7bcd4
😎 Deploy Preview https://deploy-preview-3110--kubernetes-sigs-cluster-api-openstack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@nikParasyr
Copy link
Copy Markdown
Contributor

nikParasyr commented Apr 9, 2026

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lentzi90 lentzi90 Awaiting requested review from lentzi90

@stephenfin stephenfin Awaiting requested review from stephenfin

Assignees

No one assigned

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

CAPO Roadmap
Status: Inbox

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Periodically build documentation

3 participants

@larainema @k8s-ci-robot @nikParasyr