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

DDS-2018: Build Technical Overview PDF in GitHub Action #1541

Merged
merged 4 commits into from
Jul 19, 2024

Conversation

aishling-scilifelab
Copy link
Collaborator

@aishling-scilifelab aishling-scilifelab commented Jul 16, 2024

Read this before submitting the PR

  1. Always create a Draft PR first
  2. Go through sections 1-5 below, fill them in and check all the boxes
  3. Make sure that the branch is updated; if there's an "Update branch" button at the bottom of the PR, rebase or update branch.
  4. When all boxes are checked, information is filled in, and the branch is updated: mark as Ready For Review and tag reviewers (top right)
  5. Once there is a submitted review, implement the suggestions (if reasonable, otherwise discuss) and request an new review.

If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.

1. Description / Summary

Add a summary of the changes in this PR and the related issue.

2. Jira task / GitHub issue

Link to the github issue or add the Jira task ID here.

3. Type of change

What type of change(s) does the PR contain?

Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.

  • New feature
    • Breaking: Why / How? Add info here.
    • Non-breaking
  • Database change: Remember the to include a new migration version, or explain here why it's not needed.
  • Bug fix
  • Security Alert fix
    • Package update
      • Major version update
  • Documentation
  • Workflow
  • Tests only

4. Additional information

5. Actions / Scans

Check the boxes when the specified checks have passed.

For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the PR template.

  • Black
  • Prettier
  • Yamllint
  • Tests
  • CodeQL
  • Trivy
  • Snyk

@aishling-scilifelab aishling-scilifelab force-pushed the DDS-2018-build-tech-overview branch 5 times, most recently from a76e67b to 0d6d0bf Compare July 18, 2024 20:22
@aishling-scilifelab aishling-scilifelab changed the title WIP DDS-2018 DDS-2018: Build Technical Overview PDF in GitHub Action Jul 18, 2024
@aishling-scilifelab aishling-scilifelab marked this pull request as ready for review July 18, 2024 20:41
Copy link

codecov bot commented Jul 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.49%. Comparing base (c4aeea5) to head (90b2ee2).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1541   +/-   ##
=======================================
  Coverage   92.49%   92.49%           
=======================================
  Files          29       29           
  Lines        4850     4850           
=======================================
  Hits         4486     4486           
  Misses        364      364           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aishling-scilifelab
Copy link
Collaborator Author

aishling-scilifelab commented Jul 18, 2024

@rv0lt I'm really on the fence about the second last commit (5feee92) so would love to know what you think. I embedded the PDF to try and re-create the functionality that was already there but it's not really clear to me that it's worth having anything other than a downloadable PDF.

<br>
<div class="tech-overview-container">
Copy link
Member

Choose a reason for hiding this comment

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

I think the download option is enough. As everything stored in /static is always accessible through the URL

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great, I like that option too :)

- Modify build workflow to first run pandoc to build
 the PDF.
- Delete the pre-built PDF as MD tracked instead.
- Bump some actions to v4 due to deprecation warnings.
- Remove option from UI to read in GitHub
- Update name of PDF to dds-technical-overview because it's nice to have
DDS included when it's downloaded to the user's computer.
- Actually setting the font using the LaTeX command on L13
- No support for Windows developers.
- Add command to update tlmgr with the necessary packages and convert
the existing markdown file to a PDF.
- Could move multiple commands in there from the README.md
@aishling-scilifelab
Copy link
Collaborator Author

@rv0lt in addition to getting rid of the embedded PDF, I also renamed the downloaded PDF to be dds-technical-overview.pdf on the basis that it's kind of useful to have it labelled as DDS when it's on the user's computer.

@aishling-scilifelab aishling-scilifelab merged commit 6474bde into dev Jul 19, 2024
15 checks passed
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