https://github.com/jw3/newsforce

Enforce changelog entries
https://github.com/jw3/newsforce

actions changelog changelog-generator github-actions towncrier

Last synced: about 1 month ago
JSON representation

Enforce changelog entries

• Host: GitHub
• URL: https://github.com/jw3/newsforce
• Owner: jw3
• License: mit
• Created: 2023-12-31T13:34:29.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-01-04T12:14:18.000Z (11 months ago)
• Last Synced: 2024-10-02T10:02:10.387Z (about 2 months ago)
• Topics: actions, changelog, changelog-generator, github-actions, towncrier
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
News Force Action

===

This GitHub Action enforces changelog entries on PRs.

## Example workflow

```yaml

name: build

on: pull_request

jobs:

  enforce-changelog:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: jw3/newsforce@v0

```

## towncrier

This action ensures that a news article that relates to the current PR has been created.

The intended consumer of the news articles is `towncrier`.

The intent of this action can perhaps be better understood through their documentation:

> `towncrier` delivers the news which is convenient to those that hear it, not those that write it.

>

> That is, by duplicating what has changed from the “developer log” (which may contain complex information about the original issue, how it was fixed, who authored the fix, and who reviewed the fix) into a “news fragment” (a small file containing just enough information to be useful to end users), towncrier can produce a digest of the changes which is valuable to those who may wish to use the software. These fragments are also commonly called “topfiles” or “newsfiles”.

>

> towncrier works best in a development system where all merges involve closing a ticket.

It is noteworthy that this action does not invoke `towncrier`, so the news articles guaranteed could be consumed by

other changelog generators.

## License

MIT