Skip to content

DOC: attempt to fix contributors for 0.24.0, 0.25.0/1/2 #29152

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

Merged
merged 6 commits into from
Oct 22, 2019

Conversation

jgehrcke
Copy link
Contributor

@jgehrcke jgehrcke commented Oct 22, 2019

This hopefully addresses #29151, please review!

CC @TomAugspurger @jreback

@jreback jreback added the Docs label Oct 22, 2019
@jreback jreback added this to the 1.0 milestone Oct 22, 2019
@jreback
Copy link
Contributor

jreback commented Oct 22, 2019

lgtm. can you have a look at the other whatsnew for the same issue?

@TomAugspurger
Copy link
Contributor

Looks like there are a few

doc/source/whatsnew/v0.24.0.rst:1936:.. contributors:: v0.23.4..HEAD
doc/source/whatsnew/v0.25.1.rst:119:.. contributors:: v0.25.0..HEAD
doc/source/whatsnew/v0.25.0.rst:1270:.. contributors:: v0.24.x..HEAD
doc/source/whatsnew/v0.25.2.rst:49:.. contributors:: v0.25.1..HEAD

I think all of those can be updated.

@jgehrcke jgehrcke changed the title DOC: attempt to fix contributors for 0.24.0 DOC: attempt to fix contributors for 0.24.0, 0.25.0/1/2 Oct 22, 2019
@jgehrcke
Copy link
Contributor Author

jgehrcke commented Oct 22, 2019

Okay, the .x technique only works with branches i.e. w/o the v prefix, and even then the underlying git command might fail with

$ git shortlog -s 0.24.x..v0.25.0
fatal: ambiguous argument '0.24.x..v0.25.0': unknown revision or path not in the working tree.

Not sure how the repo is cloned / checked out in the environment used for building documentation. But in my clone of the repo I need to do

$ git shortlog -s origin/0.24.x..v0.25.0

to make this technique work.

Edit: so, either we use tags as in v0.24.2..v0.25.0 which seems to work in every build environment or we use a combination of branch names and tags as in origin/0.24.x..v0.25.0 which seems to depend on the checkout (or at least my git knowledge is not good enough to understand the requirements about the checkout here).

Going to adjust the PR to only use tags (using the latest as of today, i.e. 0.23.4 and 0.24.2 as the base).

Copy link
Contributor

@TomAugspurger TomAugspurger left a comment

Choose a reason for hiding this comment

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

You may need git fetch upstream --tags locally to test that.

@TomAugspurger TomAugspurger merged commit eb74ef0 into pandas-dev:master Oct 22, 2019
@TomAugspurger
Copy link
Contributor

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants