Fix Edit links if version is referenced by annotated tag #3302

techtonik · 2017-11-23T07:54:25Z

A better version of #3238 that fixes #1637, #1820 etc. thanks to responses from git ML.

https://public-inbox.org/git/CAPkN8x+MELCnttE+xptKzYXsYPWqbiE59LABrwNBhFroayc+wQ@mail.gmail.com/

Annotated tags in Git are special. GitHub is unable to find commit corresponding to tag hash, because annotated tags are pointing to tag meta data and need to be dereferenced first.

Fixes Edit links when pointed tag is annotated. GitHub is unable to find commit corresponding to tag hash, because annotated tags are pointing to tag meta data and need be dereferenced first. https://public-inbox.org/git/CAPkN8x+MELCnttE+xptKzYXsYPWqbiE59LABrwNBhFroayc+wQ@mail.gmail.com/

https://travis-ci.org/rtfd/readthedocs.org/jobs/306192026#L821

humitos

I'm not 100% sure to understand how for-each-ref works but I did a simple test with the https://github.com/poliastro repository and I found that none of the hash are valid in the command we are executing

[humitos@julia:poliastro|master]$ for hash in `git show-ref --tags | awk '{ print $1 }'`; do echo https://github.com/poliastro/poliastro/blob/$hash/README.rst; done

On the other hand, with the command proposed in the PR, it works properly.

[humitos@julia:poliastro|master]$ for hash in `git for-each-ref --format="%(if)%(*objectname)%(then)%(*objectname)%(else)%(objectname)%(end) %(refname)" refs/tags | awk '{ print $1 }'`; do echo https://github.com/poliastro/poliastro/blob/$hash/README.rst; done

humitos · 2017-12-21T15:59:54Z

@ericholscher this is another PR that I think it's ready for merge and it's not too big. Can you take a look at this one?

ericholscher · 2017-12-21T16:31:01Z

I'd like to see a test that shows what this is fixing? I don't understand it otherwise really.

ericholscher · 2017-12-21T16:32:19Z

Specifically, a test in our code, so that we know it doesn't break in the future :)

ericholscher · 2017-12-21T16:33:44Z

I guess we don't have much for tests on the VCS code, so will go ahead and merge this.

humitos · 2017-12-21T20:32:49Z

I think we introduce a bug here after merging the PR:

[21/Dec/2017 14:21:39] readthedocs.vcs_support.utils:99[15182]: INFO Lock (poliastro): Releasing
[21/Dec/2017 14:21:39] readthedocs.doc_builder.environments:344[15182]: ERROR (Build) [poliastro:latest] need more than 1 value to unpack
Traceback (most recent call last):
  File "/home/humitos/rtfd/code/readthedocs.org/readthedocs/projects/tasks.py", line 209, in run_setup
    self.setup_vcs()
  File "/home/humitos/rtfd/code/readthedocs.org/readthedocs/projects/tasks.py", line 339, in setup_vcs
    update_imported_docs(self.version.pk)
  File "/home/humitos/.pyenv/versions/2.7.14/envs/rtfd/lib/python2.7/site-packages/celery/local.py", line 191, in __call__
    return self._get_current_object()(*a, **kw)
  File "/home/humitos/.pyenv/versions/2.7.14/envs/rtfd/lib/python2.7/site-packages/celery/app/task.py", line 380, in __call__
    return self.run(*args, **kwargs)
  File "/home/humitos/rtfd/code/readthedocs.org/readthedocs/projects/tasks.py", line 619, in update_imported_docs
    } for v in version_repo.tags
  File "/home/humitos/rtfd/code/readthedocs.org/readthedocs/vcs_support/backends/git.py", line 95, in tags
    return self.parse_tags(stdout)
  File "/home/humitos/rtfd/code/readthedocs.org/readthedocs/vcs_support/backends/git.py", line 121, in parse_tags
    commit_hash, name = row
ValueError: need more than 1 value to unpack

This is what I get from inside the RTD code:

(Pdb++) self.run('git', 'for-each-ref', '--format="%(if)%(*objectname)%(then)%(*objectname)%(else)%(objectname)%(end) %(refname)"', 'refs/tags')
[21/Dec/2017 14:31:26] readthedocs.vcs_support.base:62[15749]: INFO VCS[poliastro:latest]: git for-each-ref --format="%(if)%(*objectname)%(then)%(*objectname)%(else)%(objectname)%(end) %(refname)" refs/tags
[21/Dec/2017 14:31:26] readthedocs.vcs_support.base:70[15749]: INFO VCS[poliastro:latest]: "cf0274439e04abc164254ed92d2bf9cc17c53dce refs/tags/v0.1.0"
"53111940f2c0dc44c729724c8a5cb19815a75448 refs/tags/v0.1.1"
"f1ac1904cb48074d2dd503399001d7dc9438472b refs/tags/v0.1.2"
"91f76e251226ac8855801a59026421b72605ddce refs/tags/v0.2.0"
"39668fae67cdd40f63513b7b5d161ee18e90064b refs/tags/v0.2.1"
"0b9044e3f75ebe048f271f83e8054c2cc880607b refs/tags/v0.3.0"
"4c2b72283ba9674c9d223207ef9d5dbf6a7778ef refs/tags/v0.3.0rc1"
"16b4b6d496fdddfea816fab6cc0ed8062180d189 refs/tags/v0.3.1"
"d888e8045011403dc30c59c1d5f376198f7bf257 refs/tags/v0.3.2"
"72f3b62bab1432948b94d3fbfb38132d7d1065a0 refs/tags/v0.3.3"
"c7b914953fe58a37f2b52274eca8210fe6eec225 refs/tags/v0.4.0"
"7f9b8208e64d6604638eedb25e27345a77e65032 refs/tags/v0.4.1"
"d08c9baf2d8d12577075d64d172f8f4103591d4c refs/tags/v0.4.2"
"564b1d19a9a2fe0f7306d833638bea839d05fbdd refs/tags/v0.4.3"
"d56e4718dd31aa651e6ed036b1607abe16aa94f0 refs/tags/v0.5.0"
"3d05513e6a78987fb10e9b9d2dd29933cb5c3939 refs/tags/v0.6.0"
"93d229833dc1b9838ab167e791d655da103a0c9f refs/tags/v0.7.0"
"72c4cf841c77bb74d1dead34a28415e42610d51c refs/tags/v0.7.0b1"
"44dbc6e26f2d0a6b395a910c39c9e8131c8946b2 refs/tags/v0.8.0"

(0, u'"cf0274439e04abc164254ed92d2bf9cc17c53dce refs/tags/v0.1.0"\n"53111940f2c0dc44c729724c8a5cb19815a75448 refs/tags/v0.1.1"\n"f1ac1904cb48074d2dd503399001d7dc9438472b refs/tags/v0.1.2"\n"91f76e251226ac8855801a59026421b72605ddce refs/tags/v0.2.0"\n"39668fae67cdd40f63513b7b5d161ee18e90064b refs/tags/v0.2.1"\n"0b9044e3f75ebe048f271f83e8054c2cc880607b refs/tags/v0.3.0"\n"4c2b72283ba9674c9d223207ef9d5dbf6a7778ef refs/tags/v0.3.0rc1"\n"16b4b6d496fdddfea816fab6cc0ed8062180d189 refs/tags/v0.3.1"\n"d888e8045011403dc30c59c1d5f376198f7bf257 refs/tags/v0.3.2"\n"72f3b62bab1432948b94d3fbfb38132d7d1065a0 refs/tags/v0.3.3"\n"c7b914953fe58a37f2b52274eca8210fe6eec225 refs/tags/v0.4.0"\n"7f9b8208e64d6604638eedb25e27345a77e65032 refs/tags/v0.4.1"\n"d08c9baf2d8d12577075d64d172f8f4103591d4c refs/tags/v0.4.2"\n"564b1d19a9a2fe0f7306d833638bea839d05fbdd refs/tags/v0.4.3"\n"d56e4718dd31aa651e6ed036b1607abe16aa94f0 refs/tags/v0.5.0"\n"3d05513e6a78987fb10e9b9d2dd29933cb5c3939 refs/tags/v0.6.0"\n"93d229833dc1b9838ab167e791d655da103a0c9f refs/tags/v0.7.0"\n"72c4cf841c77bb74d1dead34a28415e42610d51c refs/tags/v0.7.0b1"\n"44dbc6e26f2d0a6b395a910c39c9e8131c8946b2 refs/tags/v0.8.0"\n', u'')
(Pdb++)

and this is from my own computer:

[humitos@julia:latest|(8685e25...)]$ git for-each-ref --format="%(if)%(*objectname)%(then)%(*objectname)%(else)%(objectname)%(end) %(refname)" refs/tags
cf0274439e04abc164254ed92d2bf9cc17c53dce refs/tags/v0.1.0
53111940f2c0dc44c729724c8a5cb19815a75448 refs/tags/v0.1.1
f1ac1904cb48074d2dd503399001d7dc9438472b refs/tags/v0.1.2
91f76e251226ac8855801a59026421b72605ddce refs/tags/v0.2.0
39668fae67cdd40f63513b7b5d161ee18e90064b refs/tags/v0.2.1
0b9044e3f75ebe048f271f83e8054c2cc880607b refs/tags/v0.3.0
4c2b72283ba9674c9d223207ef9d5dbf6a7778ef refs/tags/v0.3.0rc1
16b4b6d496fdddfea816fab6cc0ed8062180d189 refs/tags/v0.3.1
d888e8045011403dc30c59c1d5f376198f7bf257 refs/tags/v0.3.2
72f3b62bab1432948b94d3fbfb38132d7d1065a0 refs/tags/v0.3.3
c7b914953fe58a37f2b52274eca8210fe6eec225 refs/tags/v0.4.0
7f9b8208e64d6604638eedb25e27345a77e65032 refs/tags/v0.4.1
d08c9baf2d8d12577075d64d172f8f4103591d4c refs/tags/v0.4.2
564b1d19a9a2fe0f7306d833638bea839d05fbdd refs/tags/v0.4.3
d56e4718dd31aa651e6ed036b1607abe16aa94f0 refs/tags/v0.5.0
3d05513e6a78987fb10e9b9d2dd29933cb5c3939 refs/tags/v0.6.0
93d229833dc1b9838ab167e791d655da103a0c9f refs/tags/v0.7.0
72c4cf841c77bb74d1dead34a28415e42610d51c refs/tags/v0.7.0b1
44dbc6e26f2d0a6b395a910c39c9e8131c8946b2 refs/tags/v0.8.0
[humitos@julia:latest|(8685e25...)]$

the difference is that from inside RTD the output comes with " at the begining and the end of the line, so it's not well split by the csv reader.

Ref: #3302 (comment)

humitos · 2017-12-21T20:37:43Z

Just propose a hotfix at #3437.

This reverts commit 1b3404b, reversing changes made to 26102e0.

magopian · 2018-02-14T09:39:07Z

Just for people coming here and thinking this PR fixed the issue: it was reverted, and is currently not fixed yet (see #3441)

This was referenced Nov 23, 2017

Fix Edit links on stable versions #3238

Closed

Edit link on stable docs is dead ethereum/web3.py#464

Closed

Fix lint line too long

4dd5605

https://travis-ci.org/rtfd/readthedocs.org/jobs/306192026#L821

humitos reviewed Nov 24, 2017

View reviewed changes

RichardLitt added the PR: ready for review label Nov 27, 2017

leplatrem mentioned this pull request Nov 28, 2017

ReadTheDocs links to "edit on github" are broken Kinto/kinto#573

Closed

humitos mentioned this pull request Nov 29, 2017

links to github are broken #3203

Closed

ericholscher merged commit 1b3404b into readthedocs:master Dec 21, 2017

humitos added a commit that referenced this pull request Dec 21, 2017

Do not use double quotes on git command with --format option

3385305

Ref: #3302 (comment)

humitos mentioned this pull request Dec 21, 2017

Do not use double quotes on git command with --format option #3437

Merged

ericholscher added a commit that referenced this pull request Dec 22, 2017

Revert "Merge pull request #3302 from techtonik/patch-2"

092d8ae

This reverts commit 1b3404b, reversing changes made to 26102e0.

humitos mentioned this pull request Dec 29, 2017

Fix git #3441

Merged

mstimberg mentioned this pull request Jan 2, 2018

Broken links in the "Edit on Github" tab brian-team/brian2#908

Closed

magopian mentioned this pull request Feb 14, 2018

Use the closest section when clicking on a headerlink that isn't in the sidebar readthedocs/sphinx_rtd_theme#330

Closed

stsewd mentioned this pull request May 2, 2018

Use gitpython for tags #4052

Merged

techtonik deleted the patch-2 branch September 20, 2018 08:26

gboeing mentioned this pull request Apr 20, 2020

"Edit on Github" link broken by annotated tag #6932

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Edit links if version is referenced by annotated tag #3302

Fix Edit links if version is referenced by annotated tag #3302

techtonik commented Nov 23, 2017

humitos left a comment

humitos commented Dec 21, 2017

ericholscher commented Dec 21, 2017

ericholscher commented Dec 21, 2017

ericholscher commented Dec 21, 2017

humitos commented Dec 21, 2017

humitos commented Dec 21, 2017

magopian commented Feb 14, 2018

Fix Edit links if version is referenced by annotated tag #3302

Fix Edit links if version is referenced by annotated tag #3302

Conversation

techtonik commented Nov 23, 2017

humitos left a comment

Choose a reason for hiding this comment

humitos commented Dec 21, 2017

ericholscher commented Dec 21, 2017

ericholscher commented Dec 21, 2017

ericholscher commented Dec 21, 2017

humitos commented Dec 21, 2017

humitos commented Dec 21, 2017

magopian commented Feb 14, 2018