Run only docs workflow #2203

pat-s · 2023-08-12T10:52:08Z

Outsourced from #2193

Due to triggers like - ".woodpecker/test.yml" the WFs will still run in this PR and changes will only take effect for a subsequent PR.

Also harmonized the use of &when and &when_paths across the workflows.

codecov-commenter · 2023-08-12T11:19:00Z

Codecov Report

❗ No coverage uploaded for pull request base (main@76f9328). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2203   +/-   ##
=======================================
  Coverage        ?   40.72%           
=======================================
  Files           ?      183           
  Lines           ?    10998           
  Branches        ?        0           
=======================================
  Hits            ?     4479           
  Misses          ?     6168           
  Partials        ?      351

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.woodpecker/docker.yml

pat-s · 2023-08-12T12:29:04Z

Now it will run anyhow as I added the .woodpecker path trigger. But we should aim for a test that skips everything after the clone step if the paths don't match.

pat-s · 2023-08-12T12:56:25Z

https://ci.woodpecker-ci.org/repos/3780/pipeline/7287 looks good. I am now commenting in all the .woodpecker paths again, which will trigger a full rerun in this PR. But for subsequent ones, it should skip them if the paths don't path the config specifications.

pat-s · 2023-08-12T12:57:29Z

Oh no, my auto-formatting made a hell of unrelated changes 🥴️

.woodpecker/docker.yml

qwerty287 · 2023-08-12T12:59:51Z

.woodpecker/docker.yml

@@ -18,10 +18,23 @@ variables:
  - &platforms_server 'linux/arm/v7,linux/arm64/v8,linux/amd64,linux/ppc64le,linux/riscv64'
  - &platforms_preview 'linux/amd64'
  - &platforms_alpine 'linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/amd64,linux/ppc64le'
+  - &when


It looks like this is unused, so we only need path as variable.

qwerty287 · 2023-08-12T13:02:08Z

.woodpecker/test.yml

@@ -25,7 +25,8 @@ steps:
    group: prepare
    commands:
      - go mod vendor
-    when: *when
+    when:
+      path: *when_path


Why did you change this?
It is currently skipped on builds on main completely, so I'd keep it as it is (same for everything else in this file)

I think I am confused with the different use of *when and *when_path across files. Trying to harmonize...

.woodpecker/test.yml

qwerty287 · 2023-08-12T13:04:18Z

.woodpecker/web.yml

@@ -24,7 +24,8 @@ steps:
    commands:
      - corepack enable
      - pnpm install --frozen-lockfile
-    when: *when
+    when:
+      path: *when_path


The when is already part of the variable. You can drop all changes like this in this file

I've changed all *when to *when_path - OK?

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>

…nto run-only-docs

pat-s · 2023-08-12T13:37:35Z

https://ci.woodpecker-ci.org/repos/3780/pipeline/7293/13 looks good now? 😅 @qwerty287

pat-s · 2023-08-12T14:11:44Z

@qwerty287 Thanks a lot for your time and patience!

pat-s · 2023-08-12T14:13:09Z

@anbraten @6543 Unfortunately my editor auto-formatted the file i.e. ' to " and the removal of some whitespace.
Do you mind? Or should I undo all changes again?
Maybe we can also add a linter/editorconfig?

anbraten · 2023-08-12T14:30:58Z

I am using prettier to format it.

pat-s · 2023-08-12T14:37:22Z

Me 2 - and this is what happens if I format the yaml files - so good for you?

In the gitea helm chart we use a yamllint WF for this - maybe we could add that one as well here? https://gitea.com/gitea/helm-chart/src/branch/main/.gitea/workflows/test-pr.yml#L35-L36
It uses this config: https://gitea.com/gitea/helm-chart/src/branch/main/.yamllint

qwerty287 · 2023-08-12T16:20:45Z

.woodpecker/test.yml


  lint-editorconfig:
    image: mstruebing/editorconfig-checker
    group: test
+    when:
+      path: *when_path


Can we add a event: pull_request here too? Just noticed that this also runs on pushes

Added it to a few more instances. Probably even more refinement possible across all pipelines.

Hmm it's actually missing for everything because you changed the when var to only use path filters. Actually every step should have this filter

@pat-s see 55134ad for what I mean - and yes, this changes almost nothing from main because the test workflow is already pretty optimized

I'll fix it throughout the day.

Overall I think it's important to reduce/avoid unneeded runs to save resources and time - even if it is a bit of tedious small-scale optimization work.

qwerty287

I'm still not happy with test because the change is not really doing something but complicates the pipeline.
You can directly take the file content of test.yml from 55134ad and apply this here - it contains all the changes but without those that are increasing complexity.

pat-s · 2023-08-15T07:22:57Z

I don't like the when: *when while other pipelines are using *when_path. To me this increases complexity across pipelines. Which is why I harmonized it.

In some occasions additional modifications to when are needed which are much easier to do when only using a when_path variable and not a when variable.

pat-s · 2023-08-16T21:30:58Z

I am not sure how/if we can find a consensus here. I am aware that the discussion which is blocking a merge is actually off-topic WRT to the PR title but I feel like aligning variable usage across pipelines is an important one ❓

6543 · 2023-08-16T21:32:22Z

I'm leaning more towards code deduplication ...

6543 · 2023-08-16T21:35:43Z

the only things I would accept right away would be the changes to add a path filter to the docker workflow ... the rest is just opinionated formating

as we do with souch bike-shading topics -> the @woodpecker-ci/owner will vote & decide ... cc @anbraten

pat-s · 2023-08-17T08:34:45Z

the rest is just opinionated formating

Again, that's what prettier did for auto-formatting the file. Either we need a better config or linter. I can remove it again but it's tedious to cherry-pick. That's why it's still in.

6543 · 2023-08-19T13:40:15Z

.woodpecker/docker.yml


  # vars used on push / tag events only
-  - publish_logins: &publish_logins
-      # Default DockerHub login
+  - publish_logins: &publish_logins # Default DockerHub login


publish_logins is not default dockerhub login ... the next entry is

pat-s · 2023-08-25T11:57:22Z

as we do with souch bike-shading topics -> the https://github.com/orgs/woodpecker-ci/teams/owner will vote & decide ... cc @anbraten

Any progress here?

pat-s · 2023-09-08T11:03:43Z

ping @anbraten @6543

- removes docker username secret (#2589) - fix `when` filters https://ci.woodpecker-ci.org/repos/3780/pipeline/8907/9 - add path filter to only build docker image if stuff was changed (or label is added) closes #2203 closes #2598

run only docs workflow

fa38934

pat-s mentioned this pull request Aug 12, 2023

Restructure k8s documentation #2193

Merged

qwerty287 reviewed Aug 12, 2023

View reviewed changes

.woodpecker/docker.yml Outdated Show resolved Hide resolved

qwerty287 added enhancement improve existing features build CI pipeline related labels Aug 12, 2023

test

9c89e3e

pat-s added 10 commits August 12, 2023 14:29

exclude .woodpecker triggers temporarly

253186b

test explicit clone

ce70770

remove clone

7c0662e

harmonzie

0d8c753

clean

2a414b4

when_path

1822574

.

7bc4813

.

cf41ab2

.

2336ae2

enable

8081459

pat-s requested a review from qwerty287 August 12, 2023 12:56

pat-s marked this pull request as ready for review August 12, 2023 12:57

qwerty287 reviewed Aug 12, 2023

View reviewed changes

pat-s and others added 6 commits August 12, 2023 15:21

Update .woodpecker/docker.yml

7080179

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>

use when_path everywhere

2917929

Merge branch 'run-only-docs' of github.com:woodpecker-ci/woodpecker i…

a3daa85

…nto run-only-docs

test

5e55e0f

when

d3f3a50

test

85b4182

re-enable yaml triggers

abf315a

qwerty287 approved these changes Aug 12, 2023

View reviewed changes

qwerty287 reviewed Aug 12, 2023

View reviewed changes

pat-s added 3 commits August 12, 2023 18:28

run lint only on PRs

43d23b0

test: redo events

892f4ec

Merge branch 'main' into run-only-docs

0b11754

pat-s requested a review from qwerty287 August 14, 2023 07:12

qwerty287 reviewed Aug 15, 2023

View reviewed changes

6543 reviewed Aug 19, 2023

View reviewed changes

pat-s added 2 commits August 25, 2023 13:56

format

ca5b08d

Merge branch 'main' into run-only-docs

b5db54e

qwerty287 mentioned this pull request Oct 23, 2023

Fix docker workflow and only run if needed #2625

Merged

qwerty287 closed this in #2625 Oct 23, 2023

qwerty287 deleted the run-only-docs branch October 25, 2023 07:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run only docs workflow #2203

Run only docs workflow #2203

pat-s commented Aug 12, 2023 •

edited

Loading

codecov-commenter commented Aug 12, 2023 •

edited

Loading

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

qwerty287 Aug 12, 2023

qwerty287 Aug 12, 2023

pat-s Aug 12, 2023

qwerty287 Aug 12, 2023

pat-s Aug 12, 2023

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

anbraten commented Aug 12, 2023

pat-s commented Aug 12, 2023

qwerty287 Aug 12, 2023

pat-s Aug 12, 2023

qwerty287 Aug 12, 2023

qwerty287 Aug 12, 2023

pat-s Aug 13, 2023

qwerty287 left a comment

pat-s commented Aug 15, 2023

pat-s commented Aug 16, 2023

6543 commented Aug 16, 2023

6543 commented Aug 16, 2023

pat-s commented Aug 17, 2023

6543 Aug 19, 2023

pat-s commented Aug 25, 2023

pat-s commented Sep 8, 2023

Run only docs workflow #2203

Run only docs workflow #2203

Conversation

pat-s commented Aug 12, 2023 • edited Loading

codecov-commenter commented Aug 12, 2023 • edited Loading

Codecov Report

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

pat-s commented Aug 12, 2023

anbraten commented Aug 12, 2023

pat-s commented Aug 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qwerty287 left a comment

Choose a reason for hiding this comment

pat-s commented Aug 15, 2023

pat-s commented Aug 16, 2023

6543 commented Aug 16, 2023

6543 commented Aug 16, 2023

pat-s commented Aug 17, 2023

Choose a reason for hiding this comment

pat-s commented Aug 25, 2023

pat-s commented Sep 8, 2023

pat-s commented Aug 12, 2023 •

edited

Loading

codecov-commenter commented Aug 12, 2023 •

edited

Loading