-
Notifications
You must be signed in to change notification settings - Fork 4
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 project specific configuration via local or remote pyproject.toml
#30
Add project specific configuration via local or remote pyproject.toml
#30
Conversation
The idea is to have three sources of configuration, in order of priority: - Local TOML file specified with --config option - Remote pyproject.toml at the last given revision - Default configuration in _config.py
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Do you mind updating the README with configuration instructions?
Of course, I just didn't get to that part yet. ^^ |
Looks good to me! As soon as there's a pointer from the README to the example config, we're good to go. |
and tweak or extend other sections accordingly.
[tool.changelist.label_section_map] | ||
".*Highlight.*" = "Highlights" | ||
".*New feature.*" = "New Features" | ||
".*API.*" = "API Changes" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re #41, the API changes section is third now.
and also hint that changelist is not intended to replace the human part in documenting a release.
If a configuration option is not specified in either file above, changelist | ||
falls back to the following configuration: | ||
|
||
````toml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could this be somehow sourced into the README from the actual reference? To lower the chance of diverging the docs from the actual behaviour.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will merge and follow-up with a PR to (hopefully) address your suggestions.
Didn't push them to scientific-python#30 in time.
Didn't push them to #30 in time.
Closes #17. Closes #23.
The idea is to have three sources of configuration, in order of priority:
--config
optionpyproject.toml
at the last given revision_config.py
For the release notes: