Add/update release and contributor howtos and adapt to how pytest does stuff #636

obestwalter · 2017-09-15T17:50:18Z

closes #614

These are my first efforts of getting to an easy release process that still does all the fancy stuff needed.

I extened towncrier to also link to prs and added a contrib folder with little helpers to automate releases.

towncrier pr is here: twisted/towncrier#92

* use new towncrier functionality render different formats * fix header levels

codecov · 2017-09-15T18:00:18Z

Codecov Report

Merging #636 into master will decrease coverage by 1.31%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #636      +/-   ##
==========================================
- Coverage   93.95%   92.63%   -1.32%     
==========================================
  Files          11       11              
  Lines        2364     2364              
==========================================
- Hits         2221     2190      -31     
- Misses        143      174      +31

Impacted Files	Coverage Δ
tox/interpreters.py	`61.71% <0%> (-20.32%)`	⬇️
tox/venv.py	`95.63% <0%> (-0.63%)`	⬇️
tox/session.py	`93.97% <0%> (-0.37%)`	⬇️
tox/config.py	`97.45% <0%> (-0.13%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a726aab...b773726. Read the comment docs.

…fixes

nicoddemus · 2017-09-15T22:42:32Z

pyproject.toml

+    [[tool.towncrier.format]]
+        kind = "pull request"
+        patterns = ["pr(\\d)", "pull-request(\\d)"]
+        format = "`#{id} <https://github.com/tox-dev/tox/pull/{id}>`_"


FYI GitHub doesn't care if you use /pull/ or /issue/ on the URL as long as the number is correct.

Really? Can't they overlap? Why did nobody tell me earlier? All this programming for nothing? I am disappoint :(

oh dear ... anyway. I had a blissfull afternoon exploring towncrier and all, so who cares :)

I think it's a complete UX fail then that they even have /issues and pull/ - they should just have entity/ or sometting and don't redirect from issue to pull when you ref a pull from an issue url.

Yep, it is weird 😁

FYI, although it is a redirect, it's a permanent redirect; so if you leave it as it is the sphinx link checker would complain about it.

Thanks @gaborbernat - I will keep that in mind when finishing up today.

obestwalter · 2017-09-19T17:08:50Z

I consider this as done as possible now and will make sure to iron out any kinks over time.

asottile

mostly nitpicks :)

asottile · 2017-09-19T22:37:05Z

tox.ini

@@ -39,6 +39,8 @@ description = run static analysis and style check using flake8
 commands = python -m flake8 --show-source tox setup.py {posargs}
           python -m flake8 --show-source doc tests {posargs}
           pre-commit run --all-files
+           echo "hint: run {envdir}/bint/pre-commit install" to add checks as pre-commit hook


s/bint/bin/g

You could also just run this directly: pre-commit install --overwrite: here's an example

asottile · 2017-09-19T22:37:53Z

tox.ini


-[testenv:style]
+[testenv:fix-lint]


I expect a change to appveyor.yml (where this gets currently run) as well

heh in fact this is a sneaky way to skip the style checks: https://ci.appveyor.com/project/RonnyPfannschmidt/tox/build/1.0.444/job/mfdxp0fvjcy67g94

asottile · 2017-09-19T22:38:36Z

tox.ini

-commands = sphinx-build -d .tox/docs_doctree doc .tox/docs_out --color -W -bhtml
-           sphinx-build -d .tox/docs_doctree doc .tox/docs_out --color -W -blinkcheck
+commands = sphinx-build -d {toxworkdir}/docs_doctree doc {toxworkdir}/docs_out --color -W -bhtml
+           sphinx-build -d {toxworkdir}/docs_doctree doc {toxworkdir}/docs_out --color -W -blinkcheck


nothing worth changing I think, but I find the linkcheck really slow and really annoying when attempting to iterate on the docs -- I usually end up commenting this line out to iterate.

maybe add the linkchecker as a separate env then? 👍

asottile · 2017-09-19T22:39:37Z

tasks/pre-process-changelog.py

+
+
+def main():
+    manipulate_the_news()


worth having main() as just a trivial wrapper here? (personal opinion, feel free to ignore!) -- a simpler way to write this is main = manipulate_the_news ;)

I can see how this can be taken in two directions: my personal opinion would be to not have this trivial wrapper and just rename the manipulate_the_news function -> main. But of course feel free to ignore this comment :)

I would also say, just alias it

asottile · 2017-09-19T22:40:18Z

doc/conf.py

 import sys
 from datetime import date

 from pkg_resources import get_distribution

-sys.path.insert(0, os.path.dirname(__file__))
+here = os.path.dirname(__file__)
+sys.path.insert(0, here)


hmm, any reason these lines changed?

probably to make it more verbose 👍

nicoddemus · 2017-09-19T22:50:56Z

HOWTORELEASE.rst

+
+* tox has no long lived branches.
+
+* Pull requests get integrated into master by members of the project when they feel confident that this could be part of the next release. Small fix ups might be done right after merge instead of disscussing back and forth to get minor problems fixed. to keep the workflow simple.


"... problems fixed, to keep the workflow simple."

nicoddemus · 2017-09-19T22:52:01Z

HOWTORELEASE.rst

+* Release rights for https://pypi.org/project/tox/
+* [optional] An account on https://devpi.net to upload the package under test
+* A system with either tox + `bash <https://www.gnu.org/software/bash/>`_ or `vagrant <https://github.com/tox-dev/tox/blob/master/Vagrantfile>`_ (which contains tox + bash)
+* Accountability: if you cut a release that breaks the CI builds of projects using tox, you are expected to fix this within a reasonable time frame (hours/days - not weeks/months) - if you don't feel quite capable of doing this yet, partner up with a more experienced member of the team and make sure they got your back if things break.


nicoddemus · 2017-09-19T22:53:36Z

HOWTORELEASE.rst

+
+**Current process** pypi upload packages from `dist/` via twine.
+
+If you want to use the scripts in `task/` you need a `.pypirc` with a correctly configured `pypi` section (see below). Otherwise just upload the release package which ever way you see fit.


Nit:

``task/``, ``.pypirc``

rst uses double back-ticks for monospace formatting

This is true for the rest of the document as well

nicoddemus · 2017-09-19T22:54:22Z

HOWTORELEASE.rst

+
+If you want to use the scripts in `task/` you need a `.pypirc` with a correctly configured `pypi` section (see below). Otherwise just upload the release package which ever way you see fit.
+
+[pypi] section in `.pypirc` should look somehow like this::


You can use:

.. code-block:: ini [pypi] ;repository=https://pypi.python.org/pypi ...

For syntax highlighting (you have to remove the :: from the previous sentence).

gaborbernat · 2017-09-20T13:44:58Z

CONTRIBUTING.rst

+
+Report bugs for tox in the `issue tracker <https://github.com/tox-dev/tox/issues>`_.
+
+If you are reporting a bug, please include:


maybe point out here that tox -v contains most of this information, so they don't have to come up with it from the top of their head

gaborbernat · 2017-09-20T13:46:57Z

CONTRIBUTING.rst

+
+        $ tox -e docs
+
+    The built documentation should be available in the ``doc/_build/``.


have we changed this, I would but it under the env, so it gets cleaned up together; aka under .tox/doc. I prefer to keep the working directory clean, and have a single temporary/building directory, which already is .tox

gaborbernat · 2017-09-20T13:47:45Z

CONTRIBUTING.rst

+#. `Fork the repository<https://help.github.com/articles/fork-a-repo/>`_
+#. Make your changes.
+#. open a `pull request <https://help.github.com/articles/about-pull-requests/>`_ targeting the ``master`` branch.
+#. Follow **PEP-8**. There's a ``tox`` command to help fixing it: ``tox -e fix-lint``.


probably also mention that we have a style check tox environment that warn about non fixes, e.g. flake8

gaborbernat · 2017-09-20T13:49:43Z

appveyor.yml

@@ -1,6 +1,6 @@
 environment:
  matrix:
-    - TOXENV: style
+    - TOXENV: fix-lint


hmmm, I don't like this name, cause it does not only fixes but checks style 🤔

gaborbernat · 2017-09-20T13:50:31Z

changelog/examples.rst

@@ -0,0 +1,10 @@
+file ``544.feature.rst``::
+
+    ``tox --version`` now shows information about all registered plugins - by @obestwalter.


did we drop the user links or make them in another form?

gaborbernat · 2017-09-20T13:51:14Z

tasks/pre-process-changelog.py

+
+
+def main():
+    manipulate_the_news()


I would also say, just alias it

gaborbernat · 2017-09-20T13:52:05Z

tox.ini

+[testenv:pra]
+description = "personal release assistant" - see HOWTORELEASE.rst
+skip_install = True
+deps = devpi


add lower version constraint for this

obestwalter · 2017-09-20T21:18:55Z

My current master plan would be to merge this at the weekend after releasing 2.9 and then integrating the other docs branch. I know it's a lot of churn and not very tidy, but I am willing to take the brunt of any problems that pop up by this and fixing it as we go along.

obestwalter · 2017-09-29T11:53:31Z

o.k. I will merge this now and iron out the rest on master, changelog of 2.9 is broken and I hope to fix all this today and release a 2.9.1 simply to fix cosmetics.

obestwalter added 14 commits September 15, 2017 14:08

pyproject: categories and fine tuning

d755133

add own towncrier template and changelog dir

e4214c1

repair changelog and add preamble about versioning, compat and projects

78a3cb0

make sure h1 is h1 in changelog

8dd7bf1

towncrier changes

03a1926

* use new towncrier functionality render different formats * fix header levels

remove old formatters

5d5f107

add towncrier readme

6d1f008

example

0f4ce06

add little script to render user name links in news

93afb81

don't rerender

d23645e

remove trailing whitespace

6b53ba3

add filename

757b8ba

formatting

efb86be

add wip release helper

16d924a

obestwalter added 12 commits September 15, 2017 21:48

replace user, issues and prs with links

6eb0022

add a rudimentary readme for contrib

c373e4b

add a rudimentary readme for contrib

70fb1d7

Merge remote-tracking branch 'origin/towncrier-fixes' into towncrier-…

9bb2405

…fixes

working on release script

f879994

fix up release helpers

5979412

fix link in readme

025c713

nming things, remove unused variable

e840bc8

fix version param

97eee4b

add tox env for release

6f13229

remove installation - done in tox env

7a847b8

fix running release-helper in toxenv

edce441

nicoddemus reviewed Sep 15, 2017

View reviewed changes

obestwalter mentioned this pull request Sep 15, 2017

A more generic way to render ids from file names (e.g. issues) twisted/towncrier#92

Closed

re-add 2.8.2 entry that has gone missing

f853959

obestwalter added 7 commits September 19, 2017 14:04

remove branching info - does not apply to tox

5914743

fix line endings

eca3241

fix changelog location (like in pytest project)

61fa107

contributor docs, templates, towncrier fixes, adjust envname to pytest

eb78266

Sort contributors alphabetically like pytest does it

d81bb2d

prune, refine and reorder contributor docs

e827081

refine towncrier docs

7b817a2

obestwalter requested review from hpk42, RonnyPfannschmidt, gaborbernat and nicoddemus September 19, 2017 17:07

obestwalter changed the title ~~Finalize changelog/towncrier and add release scripts/HOWTO~~ Add/update release and contributor howtos and adapt to how pytest does stuff Sep 19, 2017

fix typo in contributor name

7d58da5

asottile reviewed Sep 19, 2017

View reviewed changes

nicoddemus reviewed Sep 19, 2017

View reviewed changes

obestwalter added 6 commits September 20, 2017 08:17

fix grammar

ef92169

fix code block declaration

1e6fed4

removed one colon too much

0eb3f43

revert unnecessary assignment

926fdb4

fix env name for style checks

8f99b1d

fix typo in pre-commit hint

f521c84

obestwalter mentioned this pull request Sep 20, 2017

[WIP] docs cleanup #640

Closed

gaborbernat requested changes Sep 20, 2017

View reviewed changes

just alias main until (if ever) more functions grow here.

a873eaf

Merge branch 'master' into towncrier-fixes

b773726

obestwalter merged commit 2657331 into tox-dev:master Sep 29, 2017

obestwalter deleted the towncrier-fixes branch September 29, 2017 11:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add/update release and contributor howtos and adapt to how pytest does stuff #636

Add/update release and contributor howtos and adapt to how pytest does stuff #636

obestwalter commented Sep 15, 2017 •

edited

Loading

codecov bot commented Sep 15, 2017 •

edited

Loading

nicoddemus Sep 15, 2017

obestwalter Sep 15, 2017

obestwalter Sep 15, 2017

obestwalter Sep 15, 2017

nicoddemus Sep 15, 2017

gaborbernat Sep 17, 2017

obestwalter Sep 17, 2017

obestwalter commented Sep 19, 2017

asottile left a comment

asottile Sep 19, 2017

asottile Sep 19, 2017

asottile Sep 19, 2017

asottile Sep 19, 2017

gaborbernat Sep 20, 2017

asottile Sep 19, 2017

asottile Sep 19, 2017

gaborbernat Sep 20, 2017

asottile Sep 19, 2017

gaborbernat Sep 20, 2017

nicoddemus Sep 19, 2017

nicoddemus Sep 19, 2017

nicoddemus Sep 19, 2017

nicoddemus Sep 19, 2017

nicoddemus Sep 19, 2017

gaborbernat Sep 20, 2017

gaborbernat Sep 20, 2017

gaborbernat Sep 20, 2017

gaborbernat Sep 20, 2017

gaborbernat Sep 20, 2017

gaborbernat Sep 20, 2017

gaborbernat Sep 20, 2017

obestwalter commented Sep 20, 2017 •

edited

Loading

obestwalter commented Sep 29, 2017


		* tox has no long lived branches.

		* Pull requests get integrated into master by members of the project when they feel confident that this could be part of the next release. Small fix ups might be done right after merge instead of disscussing back and forth to get minor problems fixed. to keep the workflow simple.


		Current process pypi upload packages from `dist/` via twine.

		If you want to use the scripts in `task/` you need a `.pypirc` with a correctly configured `pypi` section (see below). Otherwise just upload the release package which ever way you see fit.


		If you want to use the scripts in `task/` you need a `.pypirc` with a correctly configured `pypi` section (see below). Otherwise just upload the release package which ever way you see fit.

		[pypi] section in `.pypirc` should look somehow like this::


		Report bugs for tox in the `issue tracker <https://github.com/tox-dev/tox/issues>`_.

		If you are reporting a bug, please include:


		$ tox -e docs

		The built documentation should be available in the ``doc/_build/``.

		@@ -0,0 +1,10 @@
		file ``544.feature.rst``::

		``tox --version`` now shows information about all registered plugins - by @obestwalter.


		[testenv:style]
		[testenv:fix-lint]

Add/update release and contributor howtos and adapt to how pytest does stuff #636

Add/update release and contributor howtos and adapt to how pytest does stuff #636

Conversation

obestwalter commented Sep 15, 2017 • edited Loading

codecov bot commented Sep 15, 2017 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

obestwalter commented Sep 19, 2017

asottile left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

obestwalter commented Sep 20, 2017 • edited Loading

obestwalter commented Sep 29, 2017

obestwalter commented Sep 15, 2017 •

edited

Loading

codecov bot commented Sep 15, 2017 •

edited

Loading

obestwalter commented Sep 20, 2017 •

edited

Loading