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

Prepare using towncrier #2837

Closed
7 tasks done
htgoebel opened this issue Sep 16, 2017 · 5 comments
Closed
7 tasks done

Prepare using towncrier #2837

htgoebel opened this issue Sep 16, 2017 · 5 comments

Comments

@htgoebel
Copy link
Member

htgoebel commented Sep 16, 2017

Following up the discussion (see #2756) about implementing the use of towncrier: Things we need for towncrier:

  • decide about where to collect the newsfragments (docs/news, news, news.d, changes.d, …)
  • decide about types of changes, section titles, etc. Esp. we need a section "hooks". These seem to be configurable
    For reference: sections in the 3.3 changelog will be "Incompatible changes", "Hooks" (new and updated, fixed), "Bootloader", "Bootloader build", "Module loader" (since this effects e.g. pkgressources), "PyInstaller core" (with subsections "modulegraph" and "Included 3rd-party libraries"), "Test-suite and Continuous Integration", "Documentation", "Known Issues"
  • learn how to specify the platform in a type (if this is useful).
    This can not be done using a "type". The adequate solution is to prefix the newsfragment text with the platform, etc in parenthesis.
  • find out how we can keep the whole changelog in the file, not only the "news"
  • create a template matching our layout
  • update the developer documentation
  • update the release documentation

@xoviat I'd appreciate if you'd provide a proposal for the first points. I'll take care of updating the documentation.

@htgoebel
Copy link
Member Author

@xoviat I'd like follow your idea and use towncrier so we can speed up the release process (as you originally pushed to do). Can you please prepare this so we can put it in place after the 3.3.1 release?! Thanks.

@htgoebel
Copy link
Member Author

We might also need a section "Relaese process" or so, where we can collect changes to setup.py, towncrier setup, etc.

@htgoebel htgoebel added this to the PyInstaller 3.4 milestone Dec 13, 2017
@ghost
Copy link

ghost commented Dec 13, 2017

The only changes required to add towncrier for now are to add a "news" folder with the changes as seen here:

https://github.com/pypa/pip/tree/5d951b2a94b9b3e07e3ed23b6d39a882f8f364aa/news

We would also ideally have a bot to check this, but we can have a script run that checks the diff, I guess.

@htgoebel
Copy link
Member Author

I'm afraid, there is more todo :-) Please have a look at the first entry of this ticket.

@htgoebel htgoebel added the help wanted Seeking help by somebody with deeper knowledge on this topic. label Aug 27, 2018
@htgoebel
Copy link
Member Author

htgoebel commented Sep 5, 2018

This is done.

@htgoebel htgoebel closed this as completed Sep 5, 2018
@htgoebel htgoebel removed the help wanted Seeking help by somebody with deeper knowledge on this topic. label Sep 6, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant