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

fix version names in docs #46

Open
JamesSaxon opened this issue Apr 12, 2023 · 7 comments · Fixed by #47
Open

fix version names in docs #46

JamesSaxon opened this issue Apr 12, 2023 · 7 comments · Fixed by #47

Comments

@JamesSaxon
Copy link
Contributor

JamesSaxon commented Apr 12, 2023

@jGaboardi, ever since the update to versioneer (#39), I noticed that the versions listed in the docs show up weird -- like 0+untagged.1.g109a527:

image

Could you either advise how to fix this with a new tag, or do so and mention me?

@jGaboardi
Copy link
Member

Seems like no initial tag was ever made. I would suggest v0.0.1. When you are ready to create the tag from you machine do:

git tag -a v0.0.1 -m v0.0.1

then

git push upstream v0.0.1

@JamesSaxon
Copy link
Contributor Author

OK, thanks. I think we were at 1.1.8 on the old naming via the py files, so I'll start at 1.1.9.

@JamesSaxon
Copy link
Contributor Author

Hey @jGaboardi, the release build failed --

https://github.com/pysal/access/actions/runs/4683952297/jobs/8299566391

It seems like versioneer was set up for master whereas the repo was switched over to main?

Is it as simple as find/replacing s/master/main/g/ in versioneer.py?

@JamesSaxon JamesSaxon reopened this Apr 13, 2023
@jGaboardi
Copy link
Member

No, the failure is coming from the tools/gitcount.ipynb notebook. This is failing because the first line of __init__ no longer contains the version. The solution I used previously was to replace the # get __version__ cell with:

# get __version__
%run ../access/_version.py

then add another cell

__version__ = get_versions()["version"]

@JamesSaxon
Copy link
Contributor Author

Hey @jGaboardi, I noticed that we still have the weird versions in the docs --

image

I had pushed a tag long ago, and #47 fixed the other issue noted above.

It looks like the docs build was 'fine" at that time --

https://github.com/pysal/access/actions/runs/4909247529

I just tried making a release from that v1.1.9 tag, but perhaps I need to do something else to trigger the build?

I'm not familiar with versioneer or the current doc setup; do you have other ideas of what to check?

@jGaboardi
Copy link
Member

I will give it attention over the weekend, if that's OK. Across the ecosystem we have been a bit fluid recently with adopting improved infrastructure. For example, swaping out setup.py for pyproject.toml, versioneer for setuptools_scm, etc. Right now @weikang9009 and I are in the process of modernizing giddy in this fashion; including updating docs actions.

@jGaboardi
Copy link
Member

xref #21

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

Successfully merging a pull request may close this issue.

2 participants