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

Add a workflow to build and deploy esp-hal documentation to GitHub Pages #1248

Merged
merged 4 commits into from
Mar 7, 2024

Conversation

jessebraham
Copy link
Member

@jessebraham jessebraham commented Mar 6, 2024

Supersedes #1243, fair bit of progress on #1204 in the process.

In addition to the work done in #1243 (thanks @playfulFence!), I've made a number of small changes:

  • We now inject the package version into the URL, so that we can host multiple versions of the docs
  • Documentation deployment now happens in its own workflow
  • The index.html file was formatted, and a favicon was added
  • Took @igrr's advice and used the actions/upload-pages-artifact and actions/deploy-pages actions in the workflow

Right now the workflow must be dispatched manually, we can revisit this in the future. There are additionally a number of other improvements I'd like to make, but for the sake of getting this release out I'll worry about those details at a later time.

Successful workflow run: https://github.com/jessebraham/esp-hal/actions/runs/8177237322
Deployed: https://jessebraham.github.io/esp-hal/

@jessebraham jessebraham added the skip-changelog No changelog modification needed label Mar 6, 2024
Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@SergioGasquez SergioGasquez left a comment

Choose a reason for hiding this comment

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

LGTM! Only a small question that I have.

resources/index.html Show resolved Hide resolved
@jessebraham jessebraham added this pull request to the merge queue Mar 7, 2024
Merged via the queue into esp-rs:main with commit 518e995 Mar 7, 2024
18 of 19 checks passed
@jessebraham jessebraham mentioned this pull request Mar 7, 2024
5 tasks
@jessebraham jessebraham deleted the feature/multi-docs branch March 7, 2024 14:17
@jessebraham jessebraham mentioned this pull request Mar 7, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants