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

update fledge internals article #713

Open
maelle opened this issue Sep 25, 2023 · 1 comment
Open

update fledge internals article #713

maelle opened this issue Sep 25, 2023 · 1 comment

Comments

@maelle
Copy link
Member

maelle commented Sep 25, 2023

or drop it

@maelle
Copy link
Member Author

maelle commented Sep 25, 2023

How does fledge work?

The package can parse a git history and a NEWS.md Markdown file, using the former to update the latter.

The git history is accessed with the gert package. Each message is considered: is it a merge commit? does it use the bullet syntax? does it use conventional commits? If the answer is yes to one of these three questions it is deemed newsworthy and parsed according to its type.

The NEWS.md file is parsed thanks to Pandoc: from Markdown to HTML and then from HTML to a nested list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant