Skip to content

github: workflow: docs: Push 'main' docs to gh-pages #55

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Feb 20, 2025
Merged

github: workflow: docs: Push 'main' docs to gh-pages #55

merged 1 commit into from
Feb 20, 2025

Conversation

d3zd3z
Copy link
Collaborator

@d3zd3z d3zd3z commented Feb 18, 2025 •
edited
Loading

This modifies the doc generation workflow to have different behavior on pull requests and on pushes to 'main'.

  • For pull requests, the docs are pushed to s3, similar to before.
  • For pushes to 'main', the docs are generated, and then used to replace the current docs in gh-pages. This way, gh-pages should always hold the current docs.

@d3zd3z d3zd3z force-pushed the doc-pages branch 12 times, most recently from cc635b0 to e842336 Compare February 18, 2025 22:55
@d3zd3z
github: workflow: docs: Push 'main' docs to gh-pages
c3b7c94 
Distinguish between pull requests, and pushes to 'main'.  The pull
request docs are published on s3, with a mechanism to retire those after
a time.

Pushes to 'main' (happens when code merges) replace the documentation on
gh-pages.  These are available for anyone wanting to see "the latest
docs".

Signed-off-by: David Brown <[email protected]>

docs: Add latest commit to top of index

Insert `git show --stat HEAD` into the template for the top-level docs,
to make it easy to see what a build was generated for.

Signed-off-by: David Brown <[email protected]>
@d3zd3z d3zd3z requested review from kartben, teburd and cfriedt February 18, 2025 23:37
@d3zd3z d3zd3z merged commit dd4c47d into main Feb 20, 2025
4 checks passed
@d3zd3z d3zd3z deleted the doc-pages branch February 20, 2025 15:55
@kartben
Copy link

kartben commented Feb 20, 2025

Success! https://zephyrproject-rtos.github.io/zephyr-lang-rust/

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

@cfriedt cfriedt cfriedt approved these changes

@kartben kartben Awaiting requested review from kartben

+1 more reviewer

@teburd teburd teburd approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@d3zd3z @kartben @teburd @cfriedt