Improved usage instructions in readme file #18
Conversation
gennadiylitvinyuk
force-pushed
the
patch-1
branch
from
b94a004 to
7dc8777
Compare
README.md
Outdated
| ```yaml | ||
| name: "Continuous Integration" | ||
|
|
||
| on: [push, pull_request] |
There was a problem hiding this comment.
I should probably explain why I used the following:
on:
pull_request:
push:
branches:
- '[0-9]+.[0-9]+.x'
- 'refs/pull/*'
tags:What I found (through a LOT of trial and error), was the following:
- I started with just pull_request. When I did that, additional pushes to the PR branch would not trigger checks.
- When I added "push", without qualifications, I would get TWO runs of checks on opening a PR, one for the PR, and one for the branch. This led to unnecessary builds.
- If I added branches to the mix (as I did) to qualify which branch triggered a build... tags would not build.
Basically, I found on: [push, pull_request] was building too much, which led me to qualify the values.
If you can point to repos where you have rolled out a workflow with the simplified entry, please link me to it so I can see the build history and make sure it's working the way I would want it to; until then, I'm a bit wary of this change.
There was a problem hiding this comment.
I've thought that - '[0-9]+.[0-9]+.x' might be too much for projects which do not follow the branch strategy required by the laminas-automatic-releases GHA.
There was a problem hiding this comment.
We could demonstrate two variants, then, maybe:
- The one we're using (and link to automatic-releases to detail the why aspect)
- A more general one (and detail issues such as double-runs, if they're still valid)
froschdesign
changed the title
Improved usage instructions Fixed docker image name in local usage example Signed-off-by: Gennadiy Litvinyuk <gennadiy@gmail.com>
Changed events Signed-off-by: Gennadiy Litvinyuk <gennadiy@gmail.com>
…te CI runs Signed-off-by: Aleksei Khudiakov <aleksey@xerkus.pro>
|
Rebased to resolve conflicts. Added example with reusable workflow. Added mention of potential duplicate CI runs. |
Co-authored-by: Matthew Weier O'Phinney <matthew@weierophinney.net> Signed-off-by: Aleksei Khudiakov <aleksey@xerkus.pro>
|
@gennadiylitvinyuk thank you |
Description
Improved usage instructions
Fixed docker image name in local usage example