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.

Sign up for GitHub

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

Jump to bottom

Try using towncrier for changelog #2885

Open
valentinsulzer opened this issue Apr 19, 2023 · 6 comments · May be fixed by #3469
Open

Try using towncrier for changelog #2885

valentinsulzer opened this issue Apr 19, 2023 · 6 comments · May be fixed by #3469
Assignees
@agriyakhetarpal
Labels
difficulty: easy A good issue for someone new. Can be done in a few hours priority: low No existing plans to resolve

Comments

@valentinsulzer
Copy link
Member

https://towncrier.readthedocs.io/en/stable/

This might be easier to use than manually changing the changelog file. Could be done as part of the documentation gsoc project
@jeromtom
Copy link
Contributor

jeromtom commented May 3, 2023

Sure, we can do this as a stretch goal. The changelog is in md (markdown format), we need to change it to rst (reStructured Text) before using towncrier.

@valentinsulzer valentinsulzer added difficulty: easy A good issue for someone new. Can be done in a few hours priority: low No existing plans to resolve labels May 8, 2023
@arunavabasucom
Copy link

can i work on this ??

@valentinsulzer
Copy link
Member Author

sure

@arunavabasucom
Copy link

arunavabasucom commented May 11, 2023 •
edited

@tinosulzer , we have to do this with jinija templateing or <version>.md file for every release .

@valentinsulzer
Copy link
Member Author

@arunavabasu-03 are you still working on this?

@arunavabasucom
Copy link

@tinosulzer , we have to do this with jinija templateing or <version>.md file for every release .

Can you pls clarify this @tinosulzer ?

@agriyakhetarpal agriyakhetarpal mentioned this issue Aug 9, 2023
Closed
2 tasks
@arunavabasucom arunavabasucom mentioned this issue Aug 20, 2023
Closed
8 tasks
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Modify levels for headings and sub-headings
d96ff44
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Don't ignore the newsfragments/ folder even if empty
1632dc8
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Add towncrier configuration file
9f3331b
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Add docs about how to add news entries
877b376
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Add notes about new CHANGELOG workflow
b0075c0
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Ignore the newsfragments/ directory
294d247
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Do not manually update the CHANGELOG
6fb8cd9
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Add note about news entries in PR template
a25977a
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Don't read or open the CHANGELOG file
eec0b5e 
Let Towncrier handle it after the version has been updated
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Oct 24, 2023
@agriyakhetarpal
pybamm-team#2885 Add contributing guide links plus cleanup
39e84cc
@agriyakhetarpal agriyakhetarpal linked a pull request Oct 24, 2023 that will close this issue
Open
8 tasks
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Dec 17, 2023
@agriyakhetarpal
pybamm-team#2885 move towncrier config to pyproject.toml file
8037337
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Dec 17, 2023
@agriyakhetarpal
pybamm-team#2885 fix CHANGELOG Towncrier start header
95003ae
agriyakhetarpal added a commit to agriyakhetarpal/PyBaMM that referenced this issue Dec 17, 2023
@agriyakhetarpal
pybamm-team#2885 Don't use pipx to run Towncrier in CI
703c6fb
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@agriyakhetarpal agriyakhetarpal

Labels
difficulty: easy A good issue for someone new. Can be done in a few hours priority: low No existing plans to resolve
Projects
None yet
Milestone
No milestone
5 participants
@valentinsulzer @arunavabasucom @Saransh-cpp @agriyakhetarpal @jeromtom