Skip to content

Add branch to workflow job summary and git commit. #1424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 6, 2022
Merged

Add branch to workflow job summary and git commit. #1424

merged 1 commit into from
Sep 6, 2022

Conversation

mashhurs
Copy link
Contributor

@mashhurs mashhurs commented Sep 1, 2022

Description

  • 67 - when we take a look at workflow runs, it is hard to figure out on which branch/version we generated the docs. Since it is impossible to attach branch to workflow name at run time, this PR improves visibility of the branch by adding to job name and summary.
  • 71 - sometimes there are cases we take a look at commits to find out the branch. With this change, we add branch to commit message to make this visibility better.

Closes elastic/docs-tools#67
Closes elastic/docs-tools#71

Test

  • Run the job by replicating on my own environment: Test job
  • Result

Screen Shot 2022-09-01 at 10 02 30 AM

@mashhurs mashhurs requested a review from jsvd September 1, 2022 17:07
@mashhurs mashhurs self-assigned this Sep 1, 2022
jsvd
jsvd reviewed Sep 5, 2022
View reviewed changes
.github/workflows/reference_docs.yml
- name: Create Pull Request
run: |
curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -X POST -d "{\"title\": \"updated docs for ${{ github.event.inputs.branch }}\",\"head\": \"${BRANCH}\",\"base\": \"${{ github.event.inputs.branch }}\"}" https://api.github.com/repos/elastic/logstash-docs/pulls
- run: echo "### Updated docs for ${{ github.event.inputs.branch }} :rocket:" >> $GITHUB_STEP_SUMMARY
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool stuff!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jsvd for making this workflow happen, it is a tremendous help!

jsvd
jsvd approved these changes Sep 5, 2022
View reviewed changes
Copy link
Member

@jsvd jsvd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mashhurs mashhurs merged commit d534285 into elastic:main Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsvd jsvd jsvd approved these changes

Assignees

@mashhurs mashhurs

Labels

enhancement

Projects

None yet

Milestone

No milestone

2 participants

@mashhurs @jsvd