Switching from versioneer to setuptools-scm

[roxyboy]

A PR to switch from versioneer to setuptools_scm for managing versions.

fixes #164

[rabernat]

I think you also need to remove this stuff

xrft/xrft/__init__.py

Lines 1 to 4 in 744209f

	from ._version import get_versions
	__version__ = get_versions()["version"]
	del get_versions

plus this file: https://github.com/xgcm/xrft/blob/master/xrft/_version.py

[rabernat]

So you can see from the CI that the version is not getting set right. It's currently showing up as 0.1.dev1+gc81d518.

https://github.com/xgcm/xrft/pull/165/checks?check_run_id=3475121204#step:5:136

[rabernat]

@roxyboy - did you see Tom's comments in #164 (comment)?

[roxyboy]

@roxyboy - did you see Tom's comments in #164 (comment)?

Yes, and I've been trying to copy and paste files that he's edited but I have yet to figure it out :((

[rabernat]

Did you actually change the secrets on the repo? If not, this change will break the release process.

[roxyboy]

Thanks for pointing this out. I didn't so... I'll revert to the previous edits.

[rabernat]

Here are another thread on the same topic: pypa/setuptools_scm#414
It sounds like the core problem is described here: pypa/setuptools_scm#480

From reading that, one fix could be

    steps:
    - uses: actions/checkout@v2
      with:
        fetch-depth: 0

[rabernat]

I found more stuff that doesn't make sense here.

[rabernat]

It doesn't matter if you add this in the pre-commit workflow. It needs to be added in the workflow where you care about the version number. What you do in this workflow won't affect the other workflows.

[rabernat]

I'm going to go out on a limb and ping open-source 🦸 @ocefpaf.

Filipe, our package is in a bit of a jam. Versioneer stopped working, so we are trying to upgrade to setuptools_scm. But at this PR illustrates, we can't get it working with our release workflow (version number detected is wrong). So we are stuck, unable to release.

Do you have any tips or suggestions to help us get out of this situation? Do you see any problems with the config introduced here?

Edit: It is actually working! See https://github.com/xgcm/xrft/runs/3569028145?check_suite_focus=true#step:5:128

[ocefpaf]

I really love to be pinged on a packaging issue that get resolved in less than 10 min until I get here 😄

Shameless plug though I'm keeping a "package skeleton" as an alternative to cookie cutters out there: https://github.com/ioos/ioos-python-package-skeleton

It is supposed to be a copy-n-paste updated references for scientific Python packaging. I'm writing docs on it to make it easier to navigate them.

[rabernat]

Yes we know about the package skeleton. Unfortunately this project predates it.

[roxyboy]

Should we make a new release so that PyPI is up to date?

[rabernat]

Yes, can you try to make the release?

We released 0.3.1 on GitHub, but it didn't work for pypi (thus this PR): https://github.com/xgcm/xrft/releases
We can't delete a release, so I would move on to 0.3.2. However, to test things out, let's make a "release candidate"

Use v0.3.2-rc0 for the tag and release title when drafting a new release and check the box that says "This is a pre-release". Let's see if the release workflow works.

[rabernat]

I just ran pip install xrft==0.3.1rc0 and it worked! So I would move forward with the release of 0.3.2.

[roxyboy]

Bravo!! 👯