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

Provide interactive prompts to create fragments with the correct names #535

Closed
chadrik opened this issue Jul 19, 2023 · 2 comments
Closed

Comments

@chadrik
Copy link

chadrik commented Jul 19, 2023

As a developer, I'd like for towncrier to automatically generate the fragment file name so that I don't have to, and so that I don't make mistakes. To achieve this, towncrier create should prompt the user to input the necessary info using a library like itsprompt.

The series of prompts should be:

  • unique id (or press enter to use timestamp)
  • fragment type
  • section (if they are configured)

This could be introduced in one of three ways:

  • add a new flag to towncrier create, e.g. towncrier create -p
  • change the default behavior of towncrier create
  • introduce a new entrypoint, such as towncrier new

Take a look at the changie new portion of the changie mege animation here: https://changie.dev/guide/quick-start/

@chadrik chadrik changed the title Provide a workflow that uses prompts to easily create fragments with the correct names Provide interactive prompts to create fragments with the correct names Jul 20, 2023
@adiroiban
Copy link
Member

Happy to review and merge a PR for this.

I think that is ok to change the defaul behaviour of towncrier create

If you don't pass a FILENAME argument it will enter the new prompt/interactive mode.

@SmileyChris
Copy link
Contributor

Implemented in #482

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

No branches or pull requests

3 participants