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

Deprecate pipeline title setting in favor of pipeline name #1704

Merged
merged 2 commits into from
Oct 18, 2023

Conversation

olblak
Copy link
Member

@olblak olblak commented Oct 17, 2023

I don't fully remember why but at some point I introduce both the pipeline setting name and title.
In my opinion they both solves the same purpose, being able to specify a small description for the pipeline such as

name: bump package version to XXX

After looking at the code, I noticed that many time I default one of the two value based on the other one, such as set name based on title, etc...

This increase even more the confusion :(

This pullrequest consolidate on name and deprecated title.
Since https://github.com/updatecli/updatecli/releases/tag/v0.63.0, jsonschema validation trigger an error if title is defined so I am planning to wait a bit before fully deprecating this setting.

Second change introduced in this pullrequest, is how actionid is generated. We now only use the pipeline title which shouldn't change over time. This fix improve pullrequest body

Please note that name and title are not related to pipelineid which solves a totally different problem.

Test

This thing that we could test is to verify that a manifest using the setting title triggers a warning message.
Everything else should be working as expected.

Additional Information

Tradeoff

Potential improvement

Signed-off-by: Olblak <me@olblak.com>
@olblak olblak added the cleanup label Oct 17, 2023
Signed-off-by: Olblak <me@olblak.com>
@olblak olblak merged commit cf10252 into updatecli:main Oct 18, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants