Skip to content

Automatically generate and commit site HTML#699

Open
nchammas wants to merge 29 commits into
apache:asf-sitefrom
nchammas:automated-html
Open

Automatically generate and commit site HTML#699
nchammas wants to merge 29 commits into
apache:asf-sitefrom
nchammas:automated-html

Conversation

@nchammas

@nchammas nchammas commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Add workflows to automatically build the site and push the generated HTML. This eliminates the need for contributors to commit or review HTML changes.

Workflow changes:

  • html-build.yml: Add a new workflow that runs on PRs and simply generates the docs. This confirms the Jekyll build is not obviously broken.
  • html-push.yml: Add a new workflow that runs on new commits to asf-site. It generates the docs and pushes the generated HTML automatically as a new commit to asf-site.
  • doc_gen.yml: Delete this workflow since it is subsumed by the new workflows.

Website source changes:

  • Stabilize the sitemap so it's generated in a deterministic manner, eliminating repeated diff noise.

Repo documentation changes:

  • Unify the build instructions so there are only two places to look: committers.md and the main repo README.
  • Add important note about content/ so its critical role is documented clearly for everyone.

This is a second attempt at #697 (which was reverted in #698).

@nchammas

Copy link
Copy Markdown
Contributor Author

cc @cloud-fan @holdenk

If you'd like to setup a staging site to test this out, I'm happy to help with that.

Otherwise, if/when we merge this, let's confirm the deployed production site is still working as expected so we can revert quickly if necessary.

@holdenk

holdenk commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

I am -1 on this change until the in flight releases are complete and distributed I don't think it's worth the risk. After those are done (hopefully middle of this month but you never know), happy to revisit. To be clear this is an explicit but temporary veto on changing the website build until after 4.2.0/4.1.3/4.0.4/3.5.9 are all released. I think this is a change we do really need (and greatly appreciate @nchammas for doing the work here), just the timing doesn't work in my mind.

@nchammas

Copy link
Copy Markdown
Contributor Author

Yes, I agree, no rush. Let's wait until all these upcoming releases are complete.

Unless we invest in setting up a proper staging site (or per-PR staging sites, though it's not clear to me whether that's possible), the only way to fully test this new setup is with a production deployment.

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