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

chore: Install pandoc manually from GitHub release binaries #2307

Merged
merged 2 commits into from
Sep 6, 2023

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Aug 30, 2023

Description

  • Ubuntu 22.04 (current operating system for GitHub Actions runners for 'ubuntu-latest') will install pandoc v2.9.2.1 through apt-get which is too old for modern versions of nbsphinx. Installing directly from binaries provided on GitHub allows a workaround for getting newer versions of pandoc on runners until the GitHub Actions runner environment updates.
    • Avoids
RuntimeWarning: You are using an unsupported version of pandoc (2.9.2.1).
Your version must be at least (2.14.2) but less than (4.0.0).

from nbsphinx.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Ubuntu 22.04 (current operating system for GitHub Actions runners for
  'ubuntu-latest') will install pandoc v2.9.2.1 through apt-get which is
  too old for modern versions of nbsphinx. Installing directly from
  binaries provided on GitHub allows a workaround for getting newer versions
  of pandoc on runners until the GitHub Actions runner environment
  updates.
   - Avoids

---
RuntimeWarning: You are using an unsupported version of pandoc (2.9.2.1).
Your version must be at least (2.14.2) but less than (4.0.0).
---

   from nbsphinx.

@matthewfeickert matthewfeickert added docs Documentation related fix A bug fix need-to-backport tmp label until can be backported to patch release branch labels Aug 30, 2023
@matthewfeickert matthewfeickert self-assigned this Aug 30, 2023
@codecov
Copy link

codecov bot commented Aug 30, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (2325b05) 98.30% compared to head (266c254) 98.30%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2307   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          69       69           
  Lines        4535     4535           
  Branches      802      802           
=======================================
  Hits         4458     4458           
  Misses         45       45           
  Partials       32       32           
Flag Coverage Δ
contrib 97.88% <ø> (ø)
doctest 61.05% <ø> (ø)
unittests-3.10 96.31% <ø> (ø)
unittests-3.11 96.31% <ø> (ø)
unittests-3.8 96.33% <ø> (ø)
unittests-3.9 96.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@matthewfeickert matthewfeickert changed the title fix: Install pandoc manually from GitHub release binaries chore: Install pandoc manually from GitHub release binaries Aug 30, 2023
@matthewfeickert matthewfeickert added chore Other changes that don't modify src or test files and removed fix A bug fix labels Aug 30, 2023
@matthewfeickert matthewfeickert force-pushed the fix/install-pandoc-manually branch from b430e70 to 1c60261 Compare August 30, 2023 23:38
@matthewfeickert matthewfeickert requested a review from kratsg August 30, 2023 23:39
Comment on lines +39 to +42
# Ubuntu 22.04's pandoc is too old (2.9.2.x), so install manually
# until the ubuntu-latest updates.
curl --silent --location --remote-name https://github.com/jgm/pandoc/releases/download/3.1.6.2/pandoc-3.1.6.2-1-amd64.deb
sudo apt-get install ./pandoc-*amd64.deb
Copy link
Member Author

Choose a reason for hiding this comment

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

The runtime warning doesn't kill the build, so while this isn't stricly necessary the Ubuntu version of pandoc is very old, and so maybe it is better to use something outside the package manager but more to date.

* Ubuntu 22.04 (current operating system for GitHub Actions runners for
  'ubuntu-latest') will install pandoc v2.9.2.1 through apt-get which is
  too old for modern versions of nbsphinx. Installing directly from
  binaries provided on GitHub allows a workaround for getting newer versions
  of pandoc on runners until the GitHub Actions runner environment
  updates.
   - Avoids

```
RuntimeWarning: You are using an unsupported version of pandoc (2.9.2.1).
Your version must be at least (2.14.2) but less than (4.0.0).
```

   from nbsphinx.
@matthewfeickert matthewfeickert force-pushed the fix/install-pandoc-manually branch from 1c60261 to 595f493 Compare September 4, 2023 18:52
@matthewfeickert matthewfeickert merged commit 444ee42 into main Sep 6, 2023
18 checks passed
@matthewfeickert matthewfeickert deleted the fix/install-pandoc-manually branch September 6, 2023 06:44
@matthewfeickert matthewfeickert removed the need-to-backport tmp label until can be backported to patch release branch label Sep 6, 2023
matthewfeickert added a commit that referenced this pull request Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Other changes that don't modify src or test files docs Documentation related
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants