Release 0.1

[satra]

version 0.1 is ready for release. any concerns, comments:

cc: / @effigies @mgxd @djarecka

[effigies]

Sounds good to me.

[djarecka]

sounds good

[djarecka]

@effigies @mgxd - it looks it's time for me to learn how to make a release, but might need some help from you. I should probably start from having access to the PyPI

[effigies]

What's your PyPI user? Well, my first guess worked. You're now an owner of the PyPI project.

[djarecka]

@effigies - thanks! trying to keep my usernames set small ;-)

[effigies]

Good luck. And if your entire release process involves more than git, (python setup.py or pip) and twine, you've probably found an out-of-date guide.

[djarecka]

@effigies - and do you have your favorite guide?

[satra]

favorite guide for this project :)

1. update version in a branch and push to github (see versioneer docs)
2. make sure CI pass
3. use annotated git tag with semantic versioning 
4. push `--tags` to make github release
5. use setup.py to build a py3 wheel
6. use twine to push to pypi (note that you can only push one release to pypi - you cannot overwrite a release, you will be forced to update the version)

[effigies]

No, I'm terrible at collecting useful resources, and I now do this so much that I don't need to look it up. The Software Carpentries might have a good one.

Off of the top of my head, we have the deeply elaborate and in need of pruning guide to making a nibabel release, and nipype's Release checklist.

And I suppose I should clarify, by release process I mean "tagging, packaging and publishing", which use git, setup.py and twine, respectively.

There's other stuff like updating changelogs, mailmaps, Zenodo metadata, etc. I like to use a release branch for things like that, which gives people a chance to comment if necessary. And for that, I just go find an old PR and use it as a template.

[mgxd]

@djarecka I aggregated information to a wiki entry here:
https://github.com/nipype/pydra/wiki/Release-Checklist

everyone: feel free to add / change things.

[djarecka]

I think I did it, but you can check if everything is ok.

Later today will update the wiki

[satra]

overall looks good, but the tag was not annotated. so git describe doesn't work.

[effigies]

You can delete and repush an annotated tag from the CLI. GitHub takes it pretty smoothly.

# Delete your tag
git tag --delete 0.1.0
# Tag with annotation
git tag -a 0.1.0
# Delete upstream tag
git push upstream :0.1.0
# Push upstream tag
git push upstream 0.1.0

If you have a GitHub release, it will simply slip the new tag under the old release.

[satra]

thank you @djarecka and @effigies

[djarecka]

it should be better now.

@effigies - thanks, but I've changed the tag before reading your answer in full, so I kept the name 0.1. If you prefer 0.1.0 or v0.1.0, let me know

[effigies]

Pretty sure 0.1 and 0.1.0 are equivalent as far as PEP 440 is concerned, so I wouldn't worry about redoing it.

[djarecka]

ok, I saw people are definitely using this notation, so should be fine

[djarecka]

I've updated wiki, feel free to change.

do we want to create zenodo right now, or we will wait wit this?