Skip to content

Conversation

@hartwork
Copy link
Collaborator

@hartwork hartwork commented Feb 1, 2022

@ssbarnea good to merge?

@hartwork hartwork requested a review from ssbarnea as a code owner February 1, 2022 03:10
@hartwork
Copy link
Collaborator Author

hartwork commented Feb 1, 2022

PS: @ssbarnea I lack permissions to set labels as requested by CI https://github.com/pycontribs/ansi2html/runs/5015881284?check_suite_focus=true#step:4:13 it seems. Can you help?

@ssbarnea
Copy link
Member

ssbarnea commented Feb 1, 2022

In fact last two releases were not included in CHANGELOG.md file. I fixed the python version on https://github.com/pycontribs/ansi2html/releases already but it would be useful if you could just mention that changelog is now available at https://github.com/pycontribs/ansi2html/releases

@ssbarnea ssbarnea added the bug This issue/PR relates to a bug. label Feb 1, 2022
@ssbarnea
Copy link
Member

ssbarnea commented Feb 1, 2022

If you still think that the file is very useful, just add the last two missing releases from the releases page (body is already markdown) and them here. It is up to you.

I am inclined to minimize the churn on new releases, and because the github releases are automatically generated on each merge, i prefer to avoid having to remember to update one extra document. Still, I am also aware that some people consider these files essential.

@hartwork
Copy link
Collaborator Author

hartwork commented Feb 1, 2022

@ssbarnea I understand that having GitHub generate them is convenient. Right now my vote would be to copy from the into the file, and to keep the file around.

@ssbarnea
Copy link
Member

ssbarnea commented Feb 1, 2022

@ssbarnea I understand that having GitHub generate them is convenient. Right now my vote would be to copy from the into the file, and to keep the file around.

Just do it. Use edit to get markdown source for the two missing releases and repurpose this PR.

@hartwork
Copy link
Collaborator Author

hartwork commented Feb 1, 2022

@ssbarnea I had look at the change log generator now. It seems it produces markdown (while we have .rst) and there is no classification into buckets like "bugfixes" and "minor changes". So to me it looks like the auto generator is helpful but maybe best serves to feed a human post-processor rather than the eventual reading user.

@ssbarnea
Copy link
Member

ssbarnea commented Feb 1, 2022

Ahh, in that case it would be easier to convert rst to markdown, or just do the conversion manually for now. During the last year I slowly started to migrate projects to markdown as it become ubiquitous and it makes much easier for others to contribute. Also Sphinx got good support for it too.

Original source is https://github.com/pycontribs/ansi2html/releases/tag/1.7.0
Additional processing done:
- Basic RST syntax
- PR number linkification
@hartwork
Copy link
Collaborator Author

hartwork commented Feb 1, 2022

@ssbarnea I have added the 1.7.0 entries now for review.
Regarding markdown, RST has some nasty properties e.g. with regarding to some things not nesting, so I'm not against migration to markdown, as long as it's after this pull request 😄 Pandoc can likely do most of the conversion work.

@hartwork hartwork changed the title CHANGELOG.rst: Fix misleading 1.6.0 entry CHANGELOG.rst: Fix misleading 1.6.0 entry + add missing 1.7.0 entries Feb 1, 2022
@ssbarnea ssbarnea changed the title CHANGELOG.rst: Fix misleading 1.6.0 entry + add missing 1.7.0 entries CHANGELOG.rst: Fix misleading 1.6.0 entry and missing 1.7.0 entries Feb 1, 2022
@ssbarnea ssbarnea changed the title CHANGELOG.rst: Fix misleading 1.6.0 entry and missing 1.7.0 entries CHANGELOG.rst: Fix misleading 1.6.0 entry and missing 1.7.0 entries Feb 1, 2022
@ssbarnea ssbarnea merged commit 0165811 into pycontribs:main Feb 1, 2022
@hartwork hartwork deleted the fix-changelog branch February 2, 2022 23:24
@hartwork hartwork added this to the 1.7.1 milestone Feb 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug This issue/PR relates to a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants