Skip to contentSkip to conversation

gitlab: only let pages be published from default branch

PATCH In review Daniel P. Berrangé 4 participants 5 messages Jul 23, 2021 – Jul 27, 2021

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 gitlab: only let pages be published from default branch

GitLab will happily publish pages generated by the latest CI pipeline from any branch:

https://docs.gitlab.com/ee/user/project/pages/introduction.html

"Remember that GitLab Pages are by default branch/tag agnostic
and their deployment relies solely on what you specify in .gitlab-ci.yml. You can limit the pages job with the only parameter, whenever a new commit is pushed to a branch used specifically for your pages."

The current "pages" job is not limited, so it is happily publishing docs content from any branch/tag in qemu.git that gets pushed to. This means we're potentially publishing from the "staging" branch or worse from outdated "stable-NNN" branches

This change restricts it to only publish from the default branch in the main repository. For contributor forks, however, we allow it to publish from any branch, since users will have arbitrarily named topic branches in flight at any time.

---
 .gitlab-ci.d/buildtest.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
.gitlab-ci.d/buildtest.yml +18 -0
index 89df51517c..80b57b7082 100644
@@ -663,6 +663,17 @@ build-tools-and-docs-debian:
 
 # Prepare for GitLab pages deployment. Anything copied into the
 # "public" directory will be deployed to $USER.gitlab.io/$PROJECT
+#
+# GitLab publishes from any branch that triggers a CI pipeline
+#
+# For the main repo we don't want to publish from 'staging'
+# since that content may not be pushed, nor do we wish to
+# publish from 'stable-NNN' branches as that content is outdated.
+# Thus we restrict to just the default branch
+#
+# For contributor forks we want to publish from any repo so
+# that users can see the results of their commits, regardless
+# of what topic branch they're currently using
 pages:
   image: $CI_REGISTRY_IMAGE/qemu/debian-amd64:latest
   stage: test
@@ -681,3 +692,10 @@ pages:
   artifacts:
     paths:
       - public
+  rules:
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      when: on_success
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project"'
+      when: never
+    - if: '$CI_PROJECT_NAMESPACE != "qemu-project"'
+      when: on_success
Signature · 1 line
2.31.1
Reviewed-by on v2 1/1
#1 lore raw
Quoted 50 lines · Daniel P. Berrangé

GitLab will happily publish pages generated by the latest CI pipeline from any branch:

https://docs.gitlab.com/ee/user/project/pages/introduction.html

"Remember that GitLab Pages are by default branch/tag agnostic
and their deployment relies solely on what you specify in .gitlab-ci.yml. You can limit the pages job with the only parameter, whenever a new commit is pushed to a branch used specifically for your pages."

The current "pages" job is not limited, so it is happily publishing docs content from any branch/tag in qemu.git that gets pushed to. This means we're potentially publishing from the "staging" branch or worse from outdated "stable-NNN" branches

This change restricts it to only publish from the default branch in the main repository. For contributor forks, however, we allow it to publish from any branch, since users will have arbitrarily named topic branches in flight at any time.

---
 .gitlab-ci.d/buildtest.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
.gitlab-ci.d/buildtest.yml +11 -0
index 89df51517c..80b57b7082 100644
@@ -663,6 +663,17 @@ build-tools-and-docs-debian:
 
 # Prepare for GitLab pages deployment. Anything copied into the
 # "public" directory will be deployed to $USER.gitlab.io/$PROJECT
+#
+# GitLab publishes from any branch that triggers a CI pipeline
+#
+# For the main repo we don't want to publish from 'staging'
+# since that content may not be pushed, nor do we wish to
+# publish from 'stable-NNN' branches as that content is outdated.
+# Thus we restrict to just the default branch
+#
+# For contributor forks we want to publish from any repo so
+# that users can see the results of their commits, regardless
+# of what topic branch they're currently using
 pages:
   image: $CI_REGISTRY_IMAGE/qemu/debian-amd64:latest
   stage: test

.gitlab-ci.d/buildtest.yml pages: · line 701

Quoted 10 lines
.gitlab-ci.d/buildtest.yml +7 -0
@@ -681,3 +692,10 @@ pages:
   artifacts:
     paths:
       - public
+  rules:
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      when: on_success
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project"'
+      when: never
+    - if: '$CI_PROJECT_NAMESPACE != "qemu-project"'
+      when: on_success

This is the same than:

rules:
- if: '$CI_PROJECT_NAMESPACE == "qemu-project" && $CI_COMMIT_BRANCH ==
$CI_DEFAULT_BRANCH'
- if: '$CI_PROJECT_NAMESPACE != "qemu-project"'
- when: never

But in your case defaults are explicit, so better.

#2 lore raw
Quoted 64 lines · Philippe Mathieu-Daudé
Quoted 50 lines · Daniel P. Berrangé

GitLab will happily publish pages generated by the latest CI pipeline from any branch:

https://docs.gitlab.com/ee/user/project/pages/introduction.html

"Remember that GitLab Pages are by default branch/tag agnostic
and their deployment relies solely on what you specify in .gitlab-ci.yml. You can limit the pages job with the only parameter, whenever a new commit is pushed to a branch used specifically for your pages."

The current "pages" job is not limited, so it is happily publishing docs content from any branch/tag in qemu.git that gets pushed to. This means we're potentially publishing from the "staging" branch or worse from outdated "stable-NNN" branches

This change restricts it to only publish from the default branch in the main repository. For contributor forks, however, we allow it to publish from any branch, since users will have arbitrarily named topic branches in flight at any time.

---
 .gitlab-ci.d/buildtest.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
.gitlab-ci.d/buildtest.yml +11 -0
index 89df51517c..80b57b7082 100644
@@ -663,6 +663,17 @@ build-tools-and-docs-debian:
 
 # Prepare for GitLab pages deployment. Anything copied into the
 # "public" directory will be deployed to $USER.gitlab.io/$PROJECT
+#
+# GitLab publishes from any branch that triggers a CI pipeline
+#
+# For the main repo we don't want to publish from 'staging'
+# since that content may not be pushed, nor do we wish to
+# publish from 'stable-NNN' branches as that content is outdated.
+# Thus we restrict to just the default branch
+#
+# For contributor forks we want to publish from any repo so
+# that users can see the results of their commits, regardless
+# of what topic branch they're currently using
 pages:
   image: $CI_REGISTRY_IMAGE/qemu/debian-amd64:latest
   stage: test

.gitlab-ci.d/buildtest.yml pages: · line 701

Quoted 10 lines
.gitlab-ci.d/buildtest.yml +7 -0
@@ -681,3 +692,10 @@ pages:
   artifacts:
     paths:
       - public
+  rules:
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      when: on_success
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project"'
+      when: never
+    - if: '$CI_PROJECT_NAMESPACE != "qemu-project"'
+      when: on_success

This is the same than:

Quoted 7 lines

rules:
- if: '$CI_PROJECT_NAMESPACE == "qemu-project" && $CI_COMMIT_BRANCH ==
$CI_DEFAULT_BRANCH'
- if: '$CI_PROJECT_NAMESPACE != "qemu-project"'
- when: never

But in your case defaults are explicit, so better.

yeah, i find it confusing when the 'when:' clause is left out

Regards,
Daniel

Signature · 3 lines
|: 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 :|
Reviewed-by on v2 1/1
#3 lore raw
In reply to Daniel P. Berrangé
Quoted 50 lines · Daniel P. Berrangé

GitLab will happily publish pages generated by the latest CI pipeline from any branch:

https://docs.gitlab.com/ee/user/project/pages/introduction.html

"Remember that GitLab Pages are by default branch/tag agnostic
and their deployment relies solely on what you specify in .gitlab-ci.yml. You can limit the pages job with the only parameter, whenever a new commit is pushed to a branch used specifically for your pages."

The current "pages" job is not limited, so it is happily publishing docs content from any branch/tag in qemu.git that gets pushed to. This means we're potentially publishing from the "staging" branch or worse from outdated "stable-NNN" branches

This change restricts it to only publish from the default branch in the main repository. For contributor forks, however, we allow it to publish from any branch, since users will have arbitrarily named topic branches in flight at any time.

---
  .gitlab-ci.d/buildtest.yml | 18 ++++++++++++++++++
  1 file changed, 18 insertions(+)
.gitlab-ci.d/buildtest.yml +11 -0
index 89df51517c..80b57b7082 100644
@@ -663,6 +663,17 @@ build-tools-and-docs-debian:
 
  # Prepare for GitLab pages deployment. Anything copied into the
  # "public" directory will be deployed to $USER.gitlab.io/$PROJECT
+#
+# GitLab publishes from any branch that triggers a CI pipeline
+#
+# For the main repo we don't want to publish from 'staging'
+# since that content may not be pushed, nor do we wish to
+# publish from 'stable-NNN' branches as that content is outdated.
+# Thus we restrict to just the default branch
+#
+# For contributor forks we want to publish from any repo so
+# that users can see the results of their commits, regardless
+# of what topic branch they're currently using
  pages:
    image: $CI_REGISTRY_IMAGE/qemu/debian-amd64:latest
    stage: test

.gitlab-ci.d/buildtest.yml pages: · line 701

Quoted 10 lines
.gitlab-ci.d/buildtest.yml +7 -0
@@ -681,3 +692,10 @@ pages:
    artifacts:
      paths:
        - public
+  rules:
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      when: on_success
+    - if: '$CI_PROJECT_NAMESPACE == "qemu-project"'
+      when: never
+    - if: '$CI_PROJECT_NAMESPACE != "qemu-project"'
+      when: on_success
Reviewed-by on v2 1/1
#4 lore raw
In reply to Daniel P. Berrangé
Quoted 22 lines · Daniel P. Berrangé

GitLab will happily publish pages generated by the latest CI pipeline from any branch:

https://docs.gitlab.com/ee/user/project/pages/introduction.html

"Remember that GitLab Pages are by default branch/tag agnostic
and their deployment relies solely on what you specify in .gitlab-ci.yml. You can limit the pages job with the only parameter, whenever a new commit is pushed to a branch used specifically for your pages."

The current "pages" job is not limited, so it is happily publishing docs content from any branch/tag in qemu.git that gets pushed to. This means we're potentially publishing from the "staging" branch or worse from outdated "stable-NNN" branches

This change restricts it to only publish from the default branch in the main repository. For contributor forks, however, we allow it to publish from any branch, since users will have arbitrarily named topic branches in flight at any time.

Quoted 5 lines
---
 .gitlab-ci.d/buildtest.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)