Deprecate pipeline title setting in favor of pipeline name #1704
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I don't fully remember why but at some point I introduce both the pipeline setting
name
andtitle
.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 deprecatedtitle
.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
andtitle
are not related topipelineid
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