Skip to content

Commit

Permalink
Document how to upgrade noteboook requirements.txt (#1927)
Browse files Browse the repository at this point in the history
Closes #1841.

---------

Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
  • Loading branch information
Eric-Arellano and frankharkins authored Sep 11, 2024
1 parent d04d4d9 commit c62a80d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,14 @@ The add the following to your `.gitconfig` (usually found at `~/.gitconfig`).
textconv = sh -c 'sphobjinv convert plain "$0" -'
```
### Dependabot - upgrade notebook testing version
When a new version of an API is released, we should also update `nb-tester/requirements.txt` to ensure that our notebooks still work with the latest version of the API. You can do this upgrade either manually or wait for Dependabot's automated PR.
Dependabot will fail to run at first due to not having access to the token. To fix this, have someone with write access trigger CI for the PR, such as by merging main or closing then reopening the issue.
You can land the API generation separately from the `requirements.txt` version upgrade. It's high priority to get out new versions of the API docs ASAP, so you should not block that on the notebook version upgrade if you run into any complications like failing notebooks.
## Deploy guides & API docs
See the section "Syncing content with open source repo" in the internal docs repo's README.
Expand Down

0 comments on commit c62a80d

Please sign in to comment.