📚 Add comment to workflow files - Githubissues

exasol / python-toolbox

Infrastructure & Automation Tooling for Python Projects

https://exasol.github.io/python-toolbox/

MIT License

2 stars 0 forks source link

📚 Add comment to workflow files #160

Open ckunki opened 5 months ago

ckunki commented 5 months ago

Background & Context

@tkilias and I were wondering and discussing why the following section is included in the GitHub workflows proposed by PTB:

  pull_request:
    types: [opened, reopened]

We imagined the following rationale:

At the time when the pr is opened or reopened, the check results of former push operation could already be outdated
So the PR should run the checks again

Acceptance Criteria

A comment is added to the workflow files provided by the PTB, e.g. # check results of former push could be outdated
Optionally: An additional section is added to the developer guide explaining rationale and mitigation in more details.