Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the option to name the configuration file towncrier.toml #172

Merged
merged 3 commits into from
Dec 7, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Install from PyPI::
It is usable by projects written in other languages, provided you give it the version of the project when invoking it.
For Python 2/3 compatible projects, the version can be discovered automatically.

In your project root, add a ``pyproject.toml`` file.
In your project root, add a ``towncrier.toml`` or a ``pyproject.toml`` file (if both files exist, the first will take precedence).
You can configure your project in two ways.
To configure it via an explicit directory, add:

Expand Down Expand Up @@ -84,7 +84,7 @@ To produce the news file for real, run::

towncrier build

This command will remove the news files (with ``git rm``) and append the built news to the filename specified in ``towncrier.ini``, and then stage the news file changes (with ``git add``).
This command will remove the news files (with ``git rm``) and append the built news to the filename specified by ``filename`` configuration option, and then stage the news file changes (with ``git add``).
altendky marked this conversation as resolved.
Show resolved Hide resolved
It leaves committing the changes up to the user.

If you wish to have content at the top of the news file (for example, to say where you can find the tickets), put your text above a rST comment that says::
Expand Down
2 changes: 2 additions & 0 deletions src/towncrier/newsfragments/172.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The README now mentions the possibility to name the configuration file
``towncrier.toml`` (in addition to ``pyproject.toml``).