Skip to content

Explain how workflow run URL is constructed #1651

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 6 commits into from
Jan 14, 2021
Merged

Explain how workflow run URL is constructed #1651

merged 6 commits into from
Jan 14, 2021

Conversation

FloEdelmann
Copy link
Contributor

@FloEdelmann FloEdelmann commented Nov 27, 2020 •
edited
Loading

Why:

There are two different GitHub Actions workflow run URLs:

The docs don't make it clear which of these URL parameters the GITHUB_RUN_ID environment variable is. This PR tries to clarify this.

What's being changed:

I've added one sentence after the environment variables table:

grafik

Check off the following:

  • All of the tests are passing.
  • I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
  • For content changes, I have reviewed the localization checklist
  • For content changes, I have reviewed the Content style guide for GitHub Docs.

@welcome
Copy link

welcome bot commented Nov 27, 2020

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@janiceilene
Copy link
Contributor

@FloEdelmann Thanks so much for opening a PR! I'll get this triaged for review 🌟

@janiceilene janiceilene added actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team labels Dec 3, 2020
@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 11, 2020
@FloEdelmann
Copy link
Contributor Author

@janiceilene Any news?

@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Dec 11, 2020
@janiceilene
Copy link
Contributor

@FloEdelmann Thanks for your patience! Our small team is working our way through reviewing all of the amazing contributions ✨

@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 19, 2020
@FloEdelmann
Copy link
Contributor Author

@janiceilene Sorry to bother you again, I just want to keep this PR from being closed.

@github-actions github-actions bot removed the stale There is no recent activity on this issue or pull request label Dec 20, 2020
@martin389 martin389 self-requested a review December 22, 2020 04:31
@martin389
Copy link
Contributor

Hi @FloEdelmann 👋
Thanks for this contribution! It looks like there are a couple of things you'd like to address in this PR:

  • Is your main concern that the URL paths seem unclear about which is the workflow ID, and which is the job ID? For example:
    • https://github.com/sindresorhus/refined-github/actions/runs/387494159
    • https://github.com/sindresorhus/refined-github/runs/1464813172
  • For the workflow run URL, are you needing to retrieve this from within a job running on a runner? Otherwise, you could retrieve this using the API: https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-workflow-run (html_url)

@FloEdelmann
Copy link
Contributor Author

Hi @martin389, it's actually both:

I needed to retrieve the workflow run URL from within a job:
This workflow (which is triggered by a daily cron job) runs this script to regularly update a comment in this issue, in which I wanted to link to the current specific workflow run.

https://github.com/OpenLightingProject/open-fixture-library/blob/5cd0b9d9ffefd2aa3b0e648664ad807269155a90/tests/external-links.js#L215

As the docs were not clear on how to construct the workflow run URL, I found out by trial and error and thus opened this PR to save others from making the same mistake :)

@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 29, 2020
@FloEdelmann
Copy link
Contributor Author

FloEdelmann commented Dec 29, 2020 •
edited
Loading

@martin389 @janiceilene Again, I just want to keep this PR from being closed. Please take all the time you need.
Happy holidays! 🎆

@github-actions github-actions bot removed the stale There is no recent activity on this issue or pull request label Dec 30, 2020
@martin389
Copy link
Contributor

Thank you @FloEdelmann! 🎉 I'm checking this approach with our support folks 👍

@martin389 martin389 self-assigned this Dec 31, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2021

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Jan 7, 2021
@FloEdelmann
Copy link
Contributor Author

Friendly bump again :)

@github-actions github-actions bot removed the stale There is no recent activity on this issue or pull request label Jan 8, 2021
@martin389
Copy link
Contributor

Following up on this 👍

@martin389
Copy link
Contributor

The support folks are happy with this approach 👍 😄 Preparing to ship this update. 🚢

@martin389
Copy link
Contributor

A preview of this update is available in staging: https://docs-1651--patch-1.herokuapp.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables

@martin389
Copy link
Contributor

(Fixed merge conflict)

@martin389 martin389 merged commit f5dcd09 into github:main Jan 14, 2021
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

@martin389
Copy link
Contributor

👍 The new note will be available here, once published: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables

@FloEdelmann FloEdelmann deleted the patch-1 branch January 14, 2021 09:51
@FloEdelmann
Copy link
Contributor Author

Great, thanks 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martin389 martin389 martin389 approved these changes

Assignees

@martin389 martin389

Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@FloEdelmann @janiceilene @martin389