-
Notifications
You must be signed in to change notification settings - Fork 16
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
Change default value for the branch parameter to 'main' #8045
Labels
Comments
fniessink
added a commit
that referenced
this issue
Apr 28, 2024
Make the default value of branch parameters `main` instead of `master`. Note: no migration code is needed because Quality-time only uses the default value of the branch parameter upon creation of a source. Changing the default value of the branch parameter does not impact existing sources. Closes #8045.
fniessink
added a commit
that referenced
this issue
Apr 28, 2024
Make the default value of branch parameters `main` instead of `master`. Note: no migration code is needed because Quality-time only uses the default value of the branch parameter upon creation of a source. Changing the default value of the branch parameter does not impact existing sources. Closes #8045.
fniessink
added a commit
that referenced
this issue
Apr 30, 2024
Make the default value of branch parameters `main` instead of `master`. Note: no migration code is needed because Quality-time only uses the default value of the branch parameter upon creation of a source. Changing the default value of the branch parameter does not impact existing sources. Closes #8045.
fniessink
added a commit
that referenced
this issue
May 2, 2024
Make the default value of branch parameters `main` instead of `master`. Note: no migration code is needed because Quality-time only uses the default value of the branch parameter upon creation of a source. Changing the default value of the branch parameter does not impact existing sources. Closes #8045.
fniessink
added a commit
that referenced
this issue
May 16, 2024
fniessink
added a commit
that referenced
this issue
May 16, 2024
fniessink
added a commit
that referenced
this issue
May 16, 2024
fniessink
added a commit
that referenced
this issue
May 16, 2024
fniessink
added a commit
that referenced
this issue
May 16, 2024
fniessink
added a commit
that referenced
this issue
May 16, 2024
fniessink
added a commit
that referenced
this issue
May 16, 2024
fniessink
added a commit
that referenced
this issue
May 17, 2024
fniessink
added a commit
that referenced
this issue
May 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Tasks:
Branch
andBranches
parameter can be combined. In that case no default value would be needed.Combining the
Branch
andBranches
parametersThe
Branch
parameter is only used byGitLab
andAzureDevOps
, both for the metric:source_up_to_dateness
.The
Branches
parameters is only used byGitLab
for the metric:pipeline_duration
.Note that
SonarQube
also has a branch parameter, but it's not derived fromBranch
, but rather a separateStringParameter
. The analysis below only covers the use ofBranch
byGitLab
andAzureDevOps
.To decide whether
Branch
andBranches
can be combined it's important to look at the default values of the parameters.Branches
has as default value "all branches".Branch
hasmaster
(after this issue is completed:main
) as default value.When configuring
GitLab
orAzure DevOps
as source for thesource_up_to_dateness
metric, users can measure the up-to-dateness of files and of pipelines. TheBranch
parameter is only used in case of the files option: users can specify for which branch the up-to-dateness of the file should be measured.If we would replace the
Branch
parameter with theBranches
parameter, Quality-time is basically saying that by default users will want to track the up-to-dateness of files across all branches. We haven't had that request from users.Alternatively, we could change the default value of the
Branches
parameter tomain
. That would impact only thepipeline_duration
metric when used withGitLab
as source. Users that want to measure the duration of all pipelines regardless of branch would have to deletemain
from the parameter value. It seems more likely that users would want to measure the duration of all pipelines instead of just the main branch.Getting rid of the
Branch
parameter would save five lines of code in the data model.Conclusion: merging the two parameters would worsen user experience in return for a very small reduction of code size. It's not worth it.
The text was updated successfully, but these errors were encountered: