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 automated workflow publishing capabilities #29

Merged
merged 12 commits into from
May 9, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented May 9, 2024

Description

This PR adds the capability to publish the Almanac's content automatically through GitHub Actions to address #18 . This adds HTML and PDF content through GitHub Pages. I tried to include ePub with this work but found that it's more complicated than the HTML or PDF content publishing process. As a result, I plan to address that aspect outside this PR, but I don't consider it critical (as both an offline and online option are provided here).

I also noticed that:

  • the logo wasn't working when linked from an HTTP reference, so updated this.
  • publishing wasn't looking correct with a preface placeholder so I removed it entirely.

Thanks for any feedback you may have!

Closes #18 (#30 created for ePub tracking as follow-up)

What is the nature of your change?

  • Content additions or updates (adds or updates content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own contributions.
  • I have commented my content, particularly in hard-to-understand areas.
  • I have made corresponding changes to related documentation (outside of book content).
  • My changes generate no new warnings.
  • New and existing tests pass locally with my changes.
  • I have added tests that prove my additions are effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

Copy link

netlify bot commented May 9, 2024

Deploy Preview for test-almanac ready!

Name Link
🔨 Latest commit 5840261
🔍 Latest deploy log https://app.netlify.com/sites/test-almanac/deploys/663d102a964c2d0008299ee5
😎 Deploy Preview https://deploy-preview-29--test-almanac.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 site configuration.

Copy link
Contributor

@falquaddoomi falquaddoomi left a comment

Choose a reason for hiding this comment

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

Neat! All the changes look pretty straightforward. I also tried out the build-book and build-book-pdf commands locally, both of which ran to completion (including fetching Chromium, which was cool to see) and produced nice-looking output.

I've noticed that, in the PDF version of the book and when you select the ".pdf" option from the "Download" dropdown in the HTML version, the PDF has a "Skip to main content" overlay on each page that covers up some of the content. Here's an example from the PDF:

Screenshot 2024-05-09 at 9 24 20 AM

I'm approving this PR since that issue is out of scope for automating the build process, but I thought I'd mention it. I can file an issue for this one and these sorts of things in the future, if you like.

@d33bs
Copy link
Member Author

d33bs commented May 9, 2024

Thanks @falquaddoomi and @gwaybio for the reviews!

I've noticed that, in the PDF version of the book and when you select the ".pdf" option from the "Download" dropdown in the HTML version, the PDF has a "Skip to main content" overlay on each page that covers up some of the content.

Thanks for bringing this up! I did some investigation and found that this relates to jupyter-book/jupyter-book#2045 and pydata/pydata-sphinx-theme#1745 . I've added a bit of CSS to avoid displaying the "skip" content when printing through Chromium (which is how the PDF is compiled).

@d33bs d33bs merged commit 7bee74a into software-gardening:main May 9, 2024
6 checks passed
@d33bs d33bs deleted the automated-deployments branch May 9, 2024 19:17
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.

Add automated GitHub publishing capabilities
4 participants