[PATCH] gitlab-ci: Be ready for new default 'main' branch name

[PATCH] gitlab-ci: Be ready for new default 'main' branch name

[Philippe Mathieu-Daudé]

In order to be ready for the GitLab changes in using inclusive
terminology (replacing the 'master' branch name by the 'main'
branch name), rename our use of 'master' by the $CI_DEFAULT_BRANCH
environment variable, so new forks won't be facing any issue.

References:

- https://sfconservancy.org/news/2020/jun/23/gitbranchname/
- https://about.gitlab.com/blog/2021/03/10/new-git-default-branch-name/

Suggested-by: Savitoj Singh <savsingh@redhat.com>
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
---
 .gitlab-ci.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index f718b61fa78..db4e8490483 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -784,7 +784,7 @@ check-patch:
   script: .gitlab-ci.d/check-patch.py
   except:
     variables:
-      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
+      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
   variables:
     GIT_DEPTH: 1000
   allow_failure: true
@@ -797,7 +797,7 @@ check-dco:
   script: .gitlab-ci.d/check-dco.py
   except:
     variables:
-      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
+      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
   variables:
     GIT_DEPTH: 1000
 
-- 
2.26.3

Re: [PATCH] gitlab-ci: Be ready for new default 'main' branch name

[Daniel P. Berrangé]

On Tue, May 25, 2021 at 05:38:25PM +0200, Philippe Mathieu-Daudé wrote:
> In order to be ready for the GitLab changes in using inclusive
> terminology (replacing the 'master' branch name by the 'main'
> branch name), rename our use of 'master' by the $CI_DEFAULT_BRANCH
> environment variable, so new forks won't be facing any issue.

I've no objection to the actual config change, but the description is
little inaccurate IMHO. GitLab is not forcing a branch name change
into any existing repositories. It is entirely upto QEMU to decide
when to change our branch names. Forks of QEMU also won't get a new
branch name, because any branches in forks are inherited from what
exists in repository being forked and not arbitrarily renamed.

So, AFAICT, only brand new (ie empty) repositories will get 'main'
as the new default branch name.

IOW, I'd describe this as

  "We want to skip the checkpatch and DCO signoff jobs when
   pushing to the default branch. Currently this branch is
   called 'master', but we don't need to hardcode this in
   the CI configuration, because the $CI_DEFAULT_BRANCH
   env variable exposes it."

> diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
> index f718b61fa78..db4e8490483 100644
> --- a/.gitlab-ci.yml
> +++ b/.gitlab-ci.yml
> @@ -784,7 +784,7 @@ check-patch:
>    script: .gitlab-ci.d/check-patch.py
>    except:
>      variables:
> -      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
> +      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
>    variables:
>      GIT_DEPTH: 1000
>    allow_failure: true
> @@ -797,7 +797,7 @@ check-dco:
>    script: .gitlab-ci.d/check-dco.py
>    except:
>      variables:
> -      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
> +      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
>    variables:
>      GIT_DEPTH: 1000

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|

Re: [PATCH] gitlab-ci: Be ready for new default 'main' branch name

[Willian Rampazzo]

On Tue, May 25, 2021 at 12:39 PM Philippe Mathieu-Daudé
<philmd@redhat.com> wrote:
>
> In order to be ready for the GitLab changes in using inclusive
> terminology (replacing the 'master' branch name by the 'main'
> branch name), rename our use of 'master' by the $CI_DEFAULT_BRANCH
> environment variable, so new forks won't be facing any issue.
>
> References:
>
> - https://sfconservancy.org/news/2020/jun/23/gitbranchname/
> - https://about.gitlab.com/blog/2021/03/10/new-git-default-branch-name/
>
> Suggested-by: Savitoj Singh <savsingh@redhat.com>
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
>  .gitlab-ci.yml | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>

With changes to the description proposed by Daniel:

Reviewed-by: Willian Rampazzo <willianr@redhat.com>

> diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
> index f718b61fa78..db4e8490483 100644
> --- a/.gitlab-ci.yml
> +++ b/.gitlab-ci.yml
> @@ -784,7 +784,7 @@ check-patch:
>    script: .gitlab-ci.d/check-patch.py
>    except:
>      variables:
> -      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
> +      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
>    variables:
>      GIT_DEPTH: 1000
>    allow_failure: true
> @@ -797,7 +797,7 @@ check-dco:
>    script: .gitlab-ci.d/check-dco.py
>    except:
>      variables:
> -      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
> +      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
>    variables:
>      GIT_DEPTH: 1000
>
> --
> 2.26.3
>

Re: [PATCH] gitlab-ci: Be ready for new default 'main' branch name

[Philippe Mathieu-Daudé]

On 5/25/21 6:08 PM, Daniel P. Berrangé wrote:
> On Tue, May 25, 2021 at 05:38:25PM +0200, Philippe Mathieu-Daudé wrote:
>> In order to be ready for the GitLab changes in using inclusive
>> terminology (replacing the 'master' branch name by the 'main'
>> branch name), rename our use of 'master' by the $CI_DEFAULT_BRANCH
>> environment variable, so new forks won't be facing any issue.
> 
> I've no objection to the actual config change, but the description is
> little inaccurate IMHO. GitLab is not forcing a branch name change
> into any existing repositories. It is entirely upto QEMU to decide
> when to change our branch names. Forks of QEMU also won't get a new
> branch name, because any branches in forks are inherited from what
> exists in repository being forked and not arbitrarily renamed.

Oh, then I misunderstood the overall change. Thanks for correcting me.

> So, AFAICT, only brand new (ie empty) repositories will get 'main'
> as the new default branch name.
> 
> IOW, I'd describe this as
> 
>   "We want to skip the checkpatch and DCO signoff jobs when
>    pushing to the default branch. Currently this branch is
>    called 'master', but we don't need to hardcode this in
>    the CI configuration, because the $CI_DEFAULT_BRANCH
>    env variable exposes it."

OK, I'll respin, thanks!

>> diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
>> index f718b61fa78..db4e8490483 100644
>> --- a/.gitlab-ci.yml
>> +++ b/.gitlab-ci.yml
>> @@ -784,7 +784,7 @@ check-patch:
>>    script: .gitlab-ci.d/check-patch.py
>>    except:
>>      variables:
>> -      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
>> +      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
>>    variables:
>>      GIT_DEPTH: 1000
>>    allow_failure: true
>> @@ -797,7 +797,7 @@ check-dco:
>>    script: .gitlab-ci.d/check-dco.py
>>    except:
>>      variables:
>> -      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == 'master'
>> +      - $CI_PROJECT_NAMESPACE == 'qemu-project' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
>>    variables:
>>      GIT_DEPTH: 1000
> 
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
> 
> 
> Regards,
> Daniel
>