From 8b6348b97dc8414bfed2c8101a191c081473fc17 Mon Sep 17 00:00:00 2001 From: Pierre Tardy Date: Thu, 17 Nov 2016 11:37:13 +0100 Subject: [PATCH] switch releasenote generation to towncrier --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++ master/buildbot/newsfragments/README.txt | 15 ++++ .../gerritverifystatuspush.feature | 1 + .../no_pass_for_dockerworker.feature | 2 + .../stashreporter_parameters.feature | 2 + master/docs/relnotes/index.rst | 71 ++----------------- towncrier.ini | 5 ++ 7 files changed, 42 insertions(+), 67 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 master/buildbot/newsfragments/README.txt create mode 100644 master/buildbot/newsfragments/gerritverifystatuspush.feature create mode 100644 master/buildbot/newsfragments/no_pass_for_dockerworker.feature create mode 100644 master/buildbot/newsfragments/stashreporter_parameters.feature create mode 100644 towncrier.ini diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..75421f704990 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +## Remove this paragraph +Please have a look at our developer documentation before submitting your Pull Request. + +http://trac.buildbot.net/wiki/Development +And especially: +http://trac.buildbot.net/wiki/SubmittingPatches + +## Contributor Checklist: + +* [ ] I have updated the unit tests +* [ ] I have created a file in the master/buildbot/newsfragment directory (and read the README.txt in that directory) +* [ ] I have updated the appropriate documentation + diff --git a/master/buildbot/newsfragments/README.txt b/master/buildbot/newsfragments/README.txt new file mode 100644 index 000000000000..a5ca32fb6593 --- /dev/null +++ b/master/buildbot/newsfragments/README.txt @@ -0,0 +1,15 @@ +This is the directory for news fragments used by towncrier: https://github.com/hawkowl/towncrier + +towncrier has a few standard types of news fragments, signified by the file extension. These are: + +.feature: Signifying a new feature. +.bugfix: Signifying a bug fix. +.doc: Signifying a documentation improvement. +.removal: Signifying a deprecation or removal of public API. + +The core of the filename can be the fixed issue number of any uniq text relative to your work. +Buildbot project does not require a tracking ticket to be made for each contribution even if this is appreciated. + +Please point to the bug using syntax: (:bug:`NNN`) +please point to classes using syntax: :py:class:`~buildbot.reporters.http.HttpStatusBase` + diff --git a/master/buildbot/newsfragments/gerritverifystatuspush.feature b/master/buildbot/newsfragments/gerritverifystatuspush.feature new file mode 100644 index 000000000000..3063f1c8f62a --- /dev/null +++ b/master/buildbot/newsfragments/gerritverifystatuspush.feature @@ -0,0 +1 @@ +New :bb:reporter:`GerritVerifyStatusPush` can send multiple review status for the same Gerrit change. diff --git a/master/buildbot/newsfragments/no_pass_for_dockerworker.feature b/master/buildbot/newsfragments/no_pass_for_dockerworker.feature new file mode 100644 index 000000000000..003d5f15c6b6 --- /dev/null +++ b/master/buildbot/newsfragments/no_pass_for_dockerworker.feature @@ -0,0 +1,2 @@ +``password`` in :py:class:`~buildbot.plugins.worker.DockerLatentWorker` and :py:class:`~buildbot.plugins.worker.HyperLatentWorker`, can be None. + In that case, they will be auto-generated from random number. diff --git a/master/buildbot/newsfragments/stashreporter_parameters.feature b/master/buildbot/newsfragments/stashreporter_parameters.feature new file mode 100644 index 000000000000..f1e50a1a4bb9 --- /dev/null +++ b/master/buildbot/newsfragments/stashreporter_parameters.feature @@ -0,0 +1,2 @@ +:bb:reporter:`StashStatusPush` now accepts ``key``, ``buildName``, ``endDescription``, ``startDescription``, and ``verbose`` parameters to control the JSON sent to Stash. + diff --git a/master/docs/relnotes/index.rst b/master/docs/relnotes/index.rst index ae80f743396b..0bd47659435b 100644 --- a/master/docs/relnotes/index.rst +++ b/master/docs/relnotes/index.rst @@ -1,74 +1,11 @@ -Release Notes for Buildbot ``|version|`` -======================================== - .. - Any change that adds a feature or fixes a bug should have an entry here. - Most simply need an additional bulleted list item, but more significant - changes can be given a subsection of their own. - - If you can: - - please point to the bug using syntax: (:bug:`NNN`) - please point to classes using syntax: :py:class:`~buildbot.reporters.http.HttpStatusBase` - - -The following are the release notes for Buildbot ``|version|``. - -See :ref:`Upgrading to Nine` for a guide to upgrading from 0.8.x to 0.9.x - -Master ------- - -Features -~~~~~~~~ - -* ``password`` in :py:class:`~buildbot.plugins.worker.DockerLatentWorker` and :py:class:`~buildbot.plugins.worker.HyperLatentWorker`, can be None. - In that case, they will be auto-generated from random number. - -* :bb:reporter:`StashStatusPush` now accepts ``key``, ``buildName``, ``endDescription``, ``startDescription``, and ``verbose`` parameters to control the JSON sent to Stash. - -* New :bb:reporter:`GerritVerifyStatusPush` can send multiple review status for the same Gerrit change. - -Fixes -~~~~~ - - -Changes for Developers -~~~~~~~~~~~~~~~~~~~~~~ - -Features -~~~~~~~~ - -Fixes -~~~~~ - - -Deprecations, Removals, and Non-Compatible Changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Worker ------- - -Fixes -~~~~~ - -Changes for Developers -~~~~~~~~~~~~~~~~~~~~~~ - -Deprecations, Removals, and Non-Compatible Changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Details -------- - -For a more detailed description of the changes made in this version, see the git log itself: + Don't write to this file anymore!! -.. code-block:: bash + Buildbot now uses towncrier to manage its release notes. + towncrier helps to avoid the need for rebase when several people work at the same time on the releasenote files. - git log v0.9.0rc1..master + Each PR should come with a file in the master/buildbot/newsfragment directory -Older Versions --------------- Release notes for older versions of Buildbot are available in the :src:`master/docs/relnotes/` directory of the source tree. Newer versions are also available here: diff --git a/towncrier.ini b/towncrier.ini new file mode 100644 index 000000000000..64aeed206b8e --- /dev/null +++ b/towncrier.ini @@ -0,0 +1,5 @@ +[towncrier] +package_dir = master +package = buildbot +; The filename that it will write to, relative to the current dir +filename = master/docs/relnotes/index.rst