chore(release): document release steps, update metadata for new repo home #140
Conversation
RELEASE.rst
Outdated
|
|
||
| 1. Update the :code:`CHANGELOG.rst` with the new version. | ||
| 2. Bump the version number in :code:`setup.py`. | ||
| 3. Tag that commit with the version number (:code:`git tag x.y.z`). |
There was a problem hiding this comment.
It is a very common practice to store the __version__ on the init of the main module, otherwise users cannot introspect this info
https://github.com/coveralls-clients/coveralls-python/blob/master/coveralls/__init__.py#L5
so we could do something like that https://github.com/spyder-ide/qtawesome/blob/master/setup.py#L13
Or we could use versioneer
There was a problem hiding this comment.
Good idea.
So far, this PR just describes the process that had been followed before we took over. Let's collect all our ideas for changing the process going forward. Some things that come to mind:
- The
__version__thing you mentioned. - Creating eggs (see the NOTE in the new RELEASE.rst)
- Doing all this on CI, maybe kicked off by a tag
Any other thoughts?
There was a problem hiding this comment.
Yes, we should not create eggs at all, eggs are deprecated stuff. We should stick to wheels and tarred sources.
Doing all this on CI, maybe kicked off by a tag
We could, the win is minimal as this is not a common process (making releases)
Either way we should automate the changelog creation. I built a tool for that, and we are already using it in several projects. https://github.com/spyder-ide/loghub/
There was a problem hiding this comment.
LGTM otherwise, we can continue on another PR
There was a problem hiding this comment.
Auto-changleogs is a good idea. Personally, I've been using the conventional-changelog format since it seems to be gaining popularity as a standard and tools like clog for the generation, but any option works well here.
I'd also appreciate if we switched to strict semver rather than the varying tags that have been used so far.
|
We need a more diligent use of labels and milestones, which also make the changelog generation process much much easier |
|
Changes Unknown when pulling 0c376b0 on add-release-info into ** on master**. |
|
@TheKevJames please disable the super annoying messages from coveralls! |
|
Done! Also set a failing threshold on coveralls (-1% on a commit, for now). |
TheKevJames
force-pushed
the
add-release-info
branch
from
596d1e8 to
31e3345
Compare
Fixes #130
This technically touches code (
setup.py), so we should wait until CI works again before merging this