python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update changelog instructions in PR workflow

Browse source 
Updated the instructions for adding changelog entries in the pull_request_changelog.yml workflow file. The changes provide more specific instructions on how to name and write the changelog entry file. This was done to provide clearer instructions to contributors updating the changelog.
This commit is contained in:
Alex Root Junior 2023-10-08 19:22:58 +03:00
parent a2ed142557
commit cf3044687a
No known key found for this signature in database
GPG key ID: 074C1D455EBEA4AC
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.github/workflows/pull_request_changelog.yml vendored
View file

@ -55,9 +55,13 @@ jobs:
You need to add a brief description of the changes to the `CHANGES` directory. You need to add a brief description of the changes to the `CHANGES` directory.
For example, you can run `towncrier create <issue>.<type>` to create a file in the change directory and then write a description on that file. Changes file should be named like `<issue or PR number>.<category>.rst`,
example `1234.bugfix.rst` where `1234` is the PR or issue number and `bugfix` is the category.
Read more at [Towncrier docs](https://towncrier.readthedocs.io/en/latest/tutorial.html#creating-news-fragments) The content of the file should be a brief description of the changes in
the PR in the format of a description of what has been done.
Possible categories are: `feature`, `bugfix`, `doc`, `removal` and `misc`.
- name: Changelog found - name: Changelog found
if: "success()" if: "success()"