elastic / docs-tools

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

Add branch name to workflow to improve VPR workflow visibility. #85

Closed mashhurs closed 1 year ago

mashhurs commented 1 year ago

Problem description

We run the VPR workflow to generate the docs for plugin references based on the branch. As branch specifies the stack version for out case, we need to know for which version we have generated the docs. Before (till las month as I remember), it was impossible to set the workflow naming programmatically (GH didn't have an interface). And recently GH developed API to do so. We are going to leverage this functionality to improve the visibility by defining the version to the workflow name.

image

Acceptance Criteria

When running the workflow we define the version we are going to build the docs for. This version/branch should be visible on workflow title so we don't need to go to the details to figure out which version we had run.

Eg.:

image