When should I use both "github.event_name == 'push'" and "startsWith(github.ref, 'refs/tags')"?

[catanzaromj]

Hello!

The main README of this action states:

A common use case is to upload packages only on a tagged commit, to do so add a filter to the job:

if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')

I do not understand the reason for the first clause github.event_name == 'push'. What does this differentiate rather than just the latter? Or better yet, what are some examples of what gets filtered out by the adding it in?

The additional clause does not appear on packaging.python.org docs.

Any help would be greatly appreciated. Thanks!

[webknjaz]

The additional clause does not appear on packaging.python.org docs.

That tutorial shows the use of on: push. So when the workflow is triggered, the event is always push. In case of additional events that may trigger it, you may want to differentiate explicitly. I personally like to set it up in a way that building the dists happens first, then those dists are tested and only after that, the publishing happens. In that case, it's useful to have the publishing job skipped when merging to main or running for pull requests. Some people make releases without testing in between and may even rely on a trigger like release, not skipping other jobs.

I like using the workflow_dispatch trigger that gives me more control over the entire process.

So the answer to your question is that you should study GitHub docs and identify what workflow setup works for you. Covering how GitHub works is rather out of the scope of this action.