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

RTD latest build is labeled as Briefcase 0.1.dev299+gbeda029 #1339

Closed
rmartin16 opened this issue Jul 1, 2023 · 3 comments · Fixed by #1340
Closed

RTD latest build is labeled as Briefcase 0.1.dev299+gbeda029 #1339

rmartin16 opened this issue Jul 1, 2023 · 3 comments · Fixed by #1340
Labels
bug A crash or error in behavior. documentation An improvement required in the project's documentation.

Comments

@rmartin16
Copy link
Member

rmartin16 commented Jul 1, 2023

Describe the bug

RTD labeled the recent latest build from main with a strange version: Briefcase 0.1.dev299+gbeda029.

Steps to reproduce

Visit https://briefcase.readthedocs.io/en/latest/ or https://readthedocs.org/projects/briefcase/builds/21114896/.

Re-creating the RTD build environment:

mkdir briefcase-tmp && cd briefcase-tmp
git clone --no-single-branch --depth 50 https://github.com/beeware/briefcase .
git checkout --force origin/main
git clean -d -f -f
python -m venv venv
source venv/bin/activate
python -m pip install --upgrade --no-cache-dir pip setuptools
python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 'alabaster>=0.7,<0.8,!=0.7.5' commonmark==0.9.1 recommonmark==0.5.0 'sphinx<2' 'sphinx-rtd-theme<0.5' 'readthedocs-sphinx-ext<2.3' 'jinja2<3.1.0'
python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir .[dev,docs]

The last successful build determined the proper version: https://readthedocs.org/projects/briefcase/builds/21050962/

Expected behavior

The RTD latest tag should show the Briefcase SCM version for the most recent commit added to main.

Screenshots

No response

Environment

  • Operating System: RTD
  • Python version: 3.11.0
  • Software versions:
    • Briefcase:
    • Toga:
    • ...

Logs

No response

Additional context

Because of #1182, I thought https://briefcase.readthedocs.io was redirecting to latest....although, it appears to be going to stable which still shows docs for 0.3.13.

@rmartin16 rmartin16 added bug A crash or error in behavior. documentation An improvement required in the project's documentation. labels Jul 1, 2023
@rmartin16
Copy link
Member Author

This seems to be an artifact of how RTD is checking out the Briefcase repo and limiting it to a depth of 50.

related:

@rmartin16
Copy link
Member Author

Sooo....looking at the history of readthedocs/readthedocs.org#5031, it appears to situation is we have to request that RTD admins disable shallow checkouts...at least, as recently as dec 2022, some projects were doing this.

Nonetheless, readthedocs/readthedocs.org#5989 appears to have added a post_checkout hook to readthedocs.yaml where users can unshallow the repo.

@freakboy3742
Copy link
Member

Ah dangit - I forgot about #1182 - we had a recent support question about the ANDROID_SDK_ROOT variable, and I noticed that it was pointing at latest rather than stable, but I forgot the reason why - I got it confused with Toga, where it was pointing at latest to ensure that the dev version of the developer guide was there by default for the PyCon US sprints. I'll switch it back.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A crash or error in behavior. documentation An improvement required in the project's documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants