search

elastic / docs-tools

A place to put documentation tooling
4 stars 13 forks source link

Reference Doc Github action: Make it easier to see which branch corresponds to each job #67

Closed karenzone closed 2 years ago

karenzone commented 2 years ago

I'm loving the new github actions to generate plugin docs! Thank you for investing the time and effort, @jsvd.

It would be super helpful if there was an easy way to see which branch corresponds to each job.

Screen Shot 2022-03-17 at 7 34 56 PM
karenzone commented 2 years ago

@jsvd As discussed. Thanks!

mashhurs commented 2 years ago

My investigations show current feature is not feasible for now. According to GH variable explanation doc seems we can leverage GITHUB_WORKFLOW param but it is not settable. Doc does not mention that it is read-only and in case I have tried with sample action workflow and got en error. There are people who faced similar cases and requested GH to make it writable. Here is the GH discussion and I also posted a comment that for the worst case scenario to update the description (eg.: Reference Documentation generation 6: Manually run by mashhurs) would satisfy our cases.

Meanwhile I will try to discuss the alternative options like adding branch info to job summary or attaching to job name, etc..

mashhurs commented 2 years ago

Adding branch to the workflow job name and job summary to slightly improve current case. Test workflow: https://github.com/mashhurs/logstash-docs/actions/runs/2973329287