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

Add Change Log / History To Documentation #711

Open
hf-krechan opened this issue Feb 4, 2024 · 0 comments
Open

Add Change Log / History To Documentation #711

hf-krechan opened this issue Feb 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hf-krechan
Copy link
Collaborator

I came across Hatch's documentation while cleaning up and found their approach quite elegant.
They use a small custom script that effectively pulls the automatic changelog from GitHub for each new release and adds it to the existing changelog (they call it history).

Here are the results: Hatch History and the script: Validate History Script.

The crucial line in the CI can be found here: CI Line. I just wanted to note this here.

@hf-krechan hf-krechan added bug Something isn't working Python Specific 🐍 a problem that is specific to this python implementation and not the bo4e data model documentation Improvements or additions to documentation and removed bug Something isn't working Python Specific 🐍 a problem that is specific to this python implementation and not the bo4e data model labels Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant