Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit d336b51

Browse files
authored
Add a docker type to the towncrier configuration (#5673)
... and certain other changelog-related fixes
1 parent 5f158ec commit d336b51

7 files changed

Lines changed: 27 additions & 14 deletions

File tree

CONTRIBUTING.rst

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,10 @@ use github's pull request workflow to review the contribution, and either ask
3030
you to make any refinements needed or merge it and make them ourselves. The
3131
changes will then land on master when we next do a release.
3232

33-
We use `CircleCI <https://circleci.com/gh/matrix-org>`_ and `Buildkite
34-
<https://buildkite.com/matrix-dot-org/synapse>`_ for continuous integration.
35-
Buildkite builds need to be authorised by a maintainer. If your change breaks
36-
the build, this will be shown in GitHub, so please keep an eye on the pull
37-
request for feedback.
33+
We use `Buildkite <https://buildkite.com/matrix-dot-org/synapse>`_ for
34+
continuous integration. Buildkite builds need to be authorised by a
35+
maintainer. If your change breaks the build, this will be shown in GitHub, so
36+
please keep an eye on the pull request for feedback.
3837

3938
To run unit tests in a local development environment, you can use:
4039

@@ -70,13 +69,21 @@ All changes, even minor ones, need a corresponding changelog / newsfragment
7069
entry. These are managed by Towncrier
7170
(https://github.com/hawkowl/towncrier).
7271

73-
To create a changelog entry, make a new file in the ``changelog.d``
74-
file named in the format of ``PRnumber.type``. The type can be
75-
one of ``feature``, ``bugfix``, ``removal`` (also used for
76-
deprecations), or ``misc`` (for internal-only changes).
77-
78-
The content of the file is your changelog entry, which can contain Markdown
79-
formatting. The entry should end with a full stop ('.') for consistency.
72+
To create a changelog entry, make a new file in the ``changelog.d`` file named
73+
in the format of ``PRnumber.type``. The type can be one of the following:
74+
75+
* ``feature``.
76+
* ``bugfix``.
77+
* ``docker`` (for updates to the Docker image).
78+
* ``doc`` (for updates to the documentation).
79+
* ``removal`` (also used for deprecations).
80+
* ``misc`` (for internal-only changes).
81+
82+
The content of the file is your changelog entry, which should be a short
83+
description of your change in the same style as the rest of our `changelog
84+
<https://github.com/matrix-org/synapse/blob/master/CHANGES.md>`_. The file can
85+
contain Markdown formatting, and should end with a full stop ('.') for
86+
consistency.
8087

8188
Adding credits to the changelog is encouraged, we value your
8289
contributions and would like to have you shouted out in the release notes!

changelog.d/5619.docker

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Base Docker image on a newer Alpine Linux version (3.8 -> 3.10).

changelog.d/5619.misc

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Add missing space in default logging file format generated by the Docker image
1+
Add missing space in default logging file format generated by the Docker image.

changelog.d/5673.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add a `docker` type to the towncrier configuration.

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
name = "Bugfixes"
1515
showcontent = true
1616

17+
[[tool.towncrier.type]]
18+
directory = "docker"
19+
name = "Updates to the Docker image"
20+
showcontent = true
21+
1722
[[tool.towncrier.type]]
1823
directory = "doc"
1924
name = "Improved Documentation"

0 commit comments

Comments
 (0)