feat(config): allow configuration from package/workspace metadata

[orhun]

closes #1022

This PR makes it possible to configure release-plz from Cargo.toml as follows:

[workspace.metadata.release-plz.workspace]
allow_dirty = false
changelog_config = "cliff.toml"
changelog_update = true
dependencies_update = true
git_release_enable = false
git_tag_enable = true
pr_labels = ["release"]
publish_allow_dirty = false
semver_check = false

Or:

[package.metadata.release-plz.workspace]
allow_dirty = false
changelog_config = "cliff.toml"
# ...

TODOs

• Add integration tests

[orhun]

Hey @MarcoIeni, can you take a quick glance on this and let me know if you like the implementation? 🐻

[MarcoIeni]

Sure. It's a busy period. I'll do it as soon as I can :)

[orhun]

I guess the only thing left is to write some integration tests \o/

[MarcoIeni]

project_manifest is already inside self.config. You don't need this parameter.

[orhun]

self.config is a PathBuf. Not sure if I understood.

[MarcoIeni]

oops sorry. Than you can find the project manifest in cargo_metadata.workspace_root.join("Cargo.toml")

[orhun]

Not sure if we can do this. What happens if the user provided a custom path via --project-manifest?

[MarcoIeni]

Sorry, I missed this comment.
It's already taken into account here

[MarcoIeni]

Integration tests would be great 🥳

[MarcoIeni]

I don't know why cargo-assist is failing. Please ignore it 😅
Let's see if more people report the same issue.

EDIT: fixed it. GitHub actions can be annoying sometimes.

[orhun]

Any idea how to add integration tests for this? Do you have some examples?

[MarcoIeni]

release-plz integration tests are here.

Complex idea

The first test that comes to mind is specifying a different changelog_config in the Cargo.toml and testing that the changelog is generated according to the custom changelog.

You can use this test as a starting point.
Either you create a new command for the update (context.run_update() here) or you call gitea api to assert the content of the changelog.

Easier alternative

1. You copy paste this test
2. You disable the changelog with the changelog_update field in Cargo.toml
3. You assert that no PR is created

[orhun]

I tried to add integration tests in the last commit but I'm not sure if I'm on the right path. Please check it out and let me know!

[MarcoIeni]

if the project manifest exists, you ignore completely the file_contents, returning the default configuration on line 100, right? 🤔

Imagine somebody that doesn't specify the config in the Cargo.toml metadata. Their release-plz.toml file is ignored. I tested this by running your branch on release-plz itself.

[MarcoIeni]

why do you only consider the first package?
Also, metadata.packages also contains your dependencies. We should only consider workspace members.
You can find workspace members with this function.