Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: doc pages (take 2!) #1327

Merged
merged 3 commits into from
Nov 26, 2024
Merged

Conversation

jjmaestro
Copy link
Contributor

@jjmaestro jjmaestro commented Nov 20, 2024

This finally fixes the doc page generation! :) I've tested it in my main branch so that the workflows would run and produce this: https://jjmaestro.github.io/rules_foreign_cc/ :) Once this PR lands, CI/CD should finally be back to always green!

This PR does:

  • Fix the patch I broke in 3881d27 (‎docs-0.3.0.patch)
  • Generate new patches for the releases so that they work with the stardoc version in main
  • Cleanup the pages GH Actions workflow:
    • Add pre-commit linting and validation
    • Auto-generate the strategy matrix
    • Move Bazelisk and mdBook versions to env so that it's easier to test and upgrade to new versions.
    • fail-fast: false so that when one of the matrix jobs fails so that we can see failures for all of the jobs (easier to debug and the jobs are lightweight so it's not too costly).
    • Simplify the patching of old branches
    • Make steps easier to read, shortening lines and adding whitespace

I broke the patch when changing the URLs because the change was done in
a context line that doesn't exist in the real branch.
Update to docs patches so that they all build with the stardoc from
main.

NOTE: I used this gist to generate and test these patches:

https://gist.github.com/jjmaestro/8f42d1ea04988ca86011de427b245ceb
* Add pre-commit linting and validation
* Auto-generate the strategy matrix
* Move Bazelisk and mdBook versions to `env` so that it's easier to
  test and upgrade to new versions.
* `fail-fast: false` so that when one of the matrix jobs fails so that
  we can see failures for all of the jobs (easier to debug and the jobs
  are lightweight so it's not too costly).
* Simplify the patching of old branches
* Make steps easier to read, shortening lines and adding whitespace
Copy link
Member

@jsharpe jsharpe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great!

@jsharpe jsharpe merged commit 2913530 into bazel-contrib:main Nov 26, 2024
9 of 20 checks passed
@jjmaestro jjmaestro deleted the fix-doc-pages-2 branch November 27, 2024 01:54
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