Skip to content

Commit

Permalink
docs: use $HOME/.asdf/bin instead of /usr/local/bin for installin…
Browse files Browse the repository at this point in the history
…g hatch [backport 2.12] (#10937)

Backport
6db7d32
from #10931 to 2.12.

Our ReadTheDocs builds have been failing for a long time due to
permission issues when trying to install hatch in /usr/local/bin (see
example
[here](https://app.readthedocs.org/projects/ddtrace/builds/25806367/)).
The latest stable version is 2.9.6, and we are currently on 2.14.2.

This PR moves the installation to happen in $HOME/.asdf/bin instead, as
it's already created and exists on the PATH. I attempted to create
$HOME/.local/bin instead, but for some reason I'm unable to update the
PATH to include this path, so it doesn't work and I needed to use an
existing path.

Resolving this issue also surfaced Rust issues, so I went ahead and
fixed that as well.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [ ] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
  • Loading branch information
erikayasuda authored Oct 3, 2024
1 parent 981fdeb commit 9c308cc
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ build:
os: ubuntu-22.04
tools:
python: "3.10"
rust: "1.78"
commands:
- git fetch --unshallow || true
- pip install hatch~=1.8.0 hatch-containers==0.7.0
- curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y
- echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> "$BASH_ENV"
- curl -L https://github.com/pypa/hatch/releases/download/hatch-v1.12.0/hatch-x86_64-unknown-linux-gnu.tar.gz | tar zx
- install -t $HOME/.asdf/bin hatch
- hatch -q
- hatch -v run docs:sphinx-build -W -b html docs docs/_build/html
- mv docs/_build $READTHEDOCS_OUTPUT

0 comments on commit 9c308cc

Please sign in to comment.