acdh-oeaw / prosnet-workflows

Workflows for GitHub actions for Prosopography & Networks projects
2 stars 1 forks source link

Add documentation for poetry-black.yml workflow #56

Closed koeaw closed 6 months ago

koeaw commented 9 months ago
koeaw commented 9 months ago

The only thing I'm not entirely sure about is the path filter – is this a bad recommendation for our use case? Will it make Black ignore other files which might be relevant?!

koeaw commented 6 months ago

I would remove the whole Workflow triggers paragraph, as it duplicates upstream documentation and is not specific to this wofklow.

Yeah, idk anymore why I included this. Maybe I was thinking of other examples or active workflows where more keywords are being used (?) and wanted to add this as warning of sorts in case someone copy-pastes settings unaware of possible side effects.

But the example here only uses pull_request and if we assume someone wanting to extend the workflow would look at the docs, we can also assume they'll likely come across info about this potential pitfall.

koeaw commented 6 months ago

Removed the section on workflow triggers -> merging.