From 0ba04f9bf6154b106e0f20c41768120d3fb600f9 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 12 Jul 2019 12:08:09 +0100 Subject: [PATCH 1/5] Add a `docker` type to the towncrier configuration --- CONTRIBUTING.rst | 30 ++++++++++++++---------- changelog.d/{5619.misc => 5619.docker} | 0 changelog.d/{5620.bugfix => 5620.docker} | 0 changelog.d/5673.misc | 1 + pyproject.toml | 5 ++++ 5 files changed, 24 insertions(+), 12 deletions(-) rename changelog.d/{5619.misc => 5619.docker} (100%) rename changelog.d/{5620.bugfix => 5620.docker} (100%) create mode 100644 changelog.d/5673.misc diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2c44422a0e84..762a5ff7a8f7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -30,11 +30,10 @@ use github's pull request workflow to review the contribution, and either ask you to make any refinements needed or merge it and make them ourselves. The changes will then land on master when we next do a release. -We use `CircleCI `_ and `Buildkite -`_ for continuous integration. -Buildkite builds need to be authorised by a maintainer. If your change breaks -the build, this will be shown in GitHub, so please keep an eye on the pull -request for feedback. +We use `Buildkite `_ for +continuous integration. Buildkite builds need to be authorised by a +maintainer. If your change breaks the build, this will be shown in GitHub, so +please keep an eye on the pull request for feedback. To run unit tests in a local development environment, you can use: @@ -70,13 +69,20 @@ All changes, even minor ones, need a corresponding changelog / newsfragment entry. These are managed by Towncrier (https://github.com/hawkowl/towncrier). -To create a changelog entry, make a new file in the ``changelog.d`` -file named in the format of ``PRnumber.type``. The type can be -one of ``feature``, ``bugfix``, ``removal`` (also used for -deprecations), or ``misc`` (for internal-only changes). - -The content of the file is your changelog entry, which can contain Markdown -formatting. The entry should end with a full stop ('.') for consistency. +To create a changelog entry, make a new file in the ``changelog.d`` file named +in the format of ``PRnumber.type``. The type can be one of the following: + * ``feature``. + * ``bugfix``. + * ``docker`` (for updates to the Docker image). + * ``doc`` (for updates to the documentation). + * ``removal`` (also used for deprecations). + * ``misc`` (for internal-only changes). + +The content of the file is your changelog entry, which should be a short +description of your change in the same style as the rest of our `changelog +`_. The file can +contain Markdown formatting, and should end with a full stop ('.') for +consistency. Adding credits to the changelog is encouraged, we value your contributions and would like to have you shouted out in the release notes! diff --git a/changelog.d/5619.misc b/changelog.d/5619.docker similarity index 100% rename from changelog.d/5619.misc rename to changelog.d/5619.docker diff --git a/changelog.d/5620.bugfix b/changelog.d/5620.docker similarity index 100% rename from changelog.d/5620.bugfix rename to changelog.d/5620.docker diff --git a/changelog.d/5673.misc b/changelog.d/5673.misc new file mode 100644 index 000000000000..194225635834 --- /dev/null +++ b/changelog.d/5673.misc @@ -0,0 +1 @@ +Add a `docker` type to the towncrier configuration. diff --git a/pyproject.toml b/pyproject.toml index ef329aab41a3..db4a2e41e439 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,6 +14,11 @@ name = "Bugfixes" showcontent = true + [[tool.towncrier.type]] + directory = "docker" + name = "Updates to the Docker image" + showcontent = true + [[tool.towncrier.type]] directory = "doc" name = "Improved Documentation" From f113548e0d40439dc4268f9161792f53e86e6989 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Fri, 12 Jul 2019 12:09:56 +0100 Subject: [PATCH 2/5] Update CONTRIBUTING.rst formatting --- CONTRIBUTING.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 762a5ff7a8f7..fc9d0b35202a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -71,12 +71,12 @@ entry. These are managed by Towncrier To create a changelog entry, make a new file in the ``changelog.d`` file named in the format of ``PRnumber.type``. The type can be one of the following: - * ``feature``. - * ``bugfix``. - * ``docker`` (for updates to the Docker image). - * ``doc`` (for updates to the documentation). - * ``removal`` (also used for deprecations). - * ``misc`` (for internal-only changes). +* ``feature``. +* ``bugfix``. +* ``docker`` (for updates to the Docker image). +* ``doc`` (for updates to the documentation). +* ``removal`` (also used for deprecations). +* ``misc`` (for internal-only changes). The content of the file is your changelog entry, which should be a short description of your change in the same style as the rest of our `changelog From 8f1dfe43c193c37835c68f2e6e18faebbd978e18 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Fri, 12 Jul 2019 12:10:40 +0100 Subject: [PATCH 3/5] Update CONTRIBUTING.rst gahhhh rst --- CONTRIBUTING.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fc9d0b35202a..94dc6504855f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -71,6 +71,7 @@ entry. These are managed by Towncrier To create a changelog entry, make a new file in the ``changelog.d`` file named in the format of ``PRnumber.type``. The type can be one of the following: + * ``feature``. * ``bugfix``. * ``docker`` (for updates to the Docker image). From 581e2a6b83d5f538bf9ef4b714662e974b20a06c Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 12 Jul 2019 12:31:12 +0100 Subject: [PATCH 4/5] fix changelogs --- changelog.d/5619.docker | 2 +- changelog.d/5620.docker | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/changelog.d/5619.docker b/changelog.d/5619.docker index c5e22d2051ed..b69e5cc57cb5 100644 --- a/changelog.d/5619.docker +++ b/changelog.d/5619.docker @@ -1 +1 @@ -Base Docker image on a newer Alpine Linux version (3.8 -> 3.10) +Base Docker image on a newer Alpine Linux version (3.8 -> 3.10). diff --git a/changelog.d/5620.docker b/changelog.d/5620.docker index 17e1f133e847..cbb5a75d6ad5 100644 --- a/changelog.d/5620.docker +++ b/changelog.d/5620.docker @@ -1 +1 @@ -Add missing space in default logging file format generated by the Docker image +Add missing space in default logging file format generated by the Docker image. From af0a86411a55fa67a4e254d9be57a8bc2b05fe39 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 12 Jul 2019 12:42:59 +0100 Subject: [PATCH 5/5] fix changelog type --- changelog.d/{5655.doc => 5655.misc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelog.d/{5655.doc => 5655.misc} (100%) diff --git a/changelog.d/5655.doc b/changelog.d/5655.misc similarity index 100% rename from changelog.d/5655.doc rename to changelog.d/5655.misc