-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1378 from HaoZeke/addTowncrier
ENH,MAINT: Add towncrier
- Loading branch information
Showing
8 changed files
with
173 additions
and
139 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
``conda-forge`` is no longer a default channel for ``mamba``. (#1373) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Fixed a bug where ``matrix`` requirements were dropped if an environment file | ||
was specified. (#1373) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
!.gitignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
The ``mamba`` plugin works correctly for newer versions (>=1.5) of | ||
``libmambapy`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
The ``mamba`` plugin respects the ``MAMBARC`` environment if set, taking | ||
channels and channel priority from the file in the environment variable. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Usage | ||
|
||
`towncrier` is used for keeping track of the changelog. The relevant configuration aspects are: | ||
- Each file can be formatted using reST | ||
- The contents are rendered in bullets | ||
- Each file should be labeled with the corresponding **pull request**, e.g. `NUM.TYPE.rst` | ||
+ Where there is no clear corresponding pull request, `+` can be used instead of `NUM` | ||
|
||
For mapping the types to headings, the following table can be used: | ||
|
||
|
||
| **TYPE** | **Heading** | | ||
| feat | New Features | | ||
| api | API Changes | | ||
| bugfix | Bug Fixes | | ||
| misc | Other Changes and Additions | | ||
|
||
## Release | ||
|
||
|
||
```bash | ||
# View the changes | ||
towncrier build --draft --version 0.6.2 --date "$(date -u +%Y-%m-%d)" | ||
# Modify CHANGES.rst | ||
towncrier build --version 0.6.3 --date "$(date -u +%Y-%m-%d)" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
[tool.towncrier] | ||
directory = "changelog.d" | ||
filename = "CHANGES.rst" | ||
underlines = ["-", "^", "~"] | ||
wrap = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "feat" | ||
name = "New Features" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "api" | ||
name = "API Changes" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "bugfix" | ||
name = "Bug Fixes" | ||
showcontent = true | ||
|
||
[[tool.towncrier.type]] | ||
directory = "misc" | ||
name = "Other Changes and Additions" | ||
showcontent = true |