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

Add project specific configuration via local or remote pyproject.toml #30

Merged
merged 8 commits into from
Oct 3, 2023

Conversation

lagru
Copy link
Member

@lagru lagru commented Sep 23, 2023

Closes #17. Closes #23.

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

For the release notes:

Add support for configuration files either via a remote `pyproject.toml` or a local TOML
file given with the new option `--config`. This file allows the configuration of templates,
ways that changelist matches labels, finds summaries, as well as logins to ignore in the
contributor section.

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
@lagru lagru added the type: Enhancement New feature or request label Sep 23, 2023
Copy link
Member

@stefanv stefanv left a 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?

src/changelist/_config.py Outdated Show resolved Hide resolved
@lagru
Copy link
Member Author

lagru commented Sep 24, 2023

Do you mind updating the README with configuration instructions?

Of course, I just didn't get to that part yet. ^^

@stefanv
Copy link
Member

stefanv commented Sep 24, 2023

Looks good to me! As soon as there's a pointer from the README to the example config, we're good to go.

@lagru lagru marked this pull request as ready for review October 2, 2023 13:59
[tool.changelist.label_section_map]
".*Highlight.*" = "Highlights"
".*New feature.*" = "New Features"
".*API.*" = "API Changes"
Copy link
Member Author

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
Copy link
Member

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.

Copy link
Member

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.

@jarrodmillman jarrodmillman merged commit d9ac1e4 into scientific-python:main Oct 3, 2023
2 checks passed
@jarrodmillman jarrodmillman added this to the 0.4 milestone Oct 3, 2023
@lagru lagru deleted the support-config-file branch October 3, 2023 10:35
lagru added a commit to lagru/changelist that referenced this pull request Oct 3, 2023
jarrodmillman pushed a commit that referenced this pull request Oct 3, 2023
Didn't push them to
#30
in time.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ignore certain contributors Proposal: enable project specific configuration via pyproject.toml
4 participants