Skip to content
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.

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

Update accessing-contextual-information-about-workflow-runs.md #35780

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

lachieh
Copy link
Contributor

@lachieh lachieh commented Dec 28, 2024

Why:

I needed to pass the repository URL to a 3rd party action and used the github.repositoryUrl property. It took some digging to find out why the operation was timing out, but I eventually stumbled across a blog post which says to basically just stop using the git:// protocol.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Adding a note below the table to mention this restriction.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 28, 2024
…does/accessing-contextual-information-about-workflow-runs.md
@lachieh lachieh temporarily deployed to preview-env-35780 December 28, 2024 02:27 — with GitHub Actions Inactive
Copy link
Contributor

github-actions bot commented Dec 28, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@lachieh lachieh temporarily deployed to preview-env-35780 December 28, 2024 02:34 — with GitHub Actions Inactive
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Dec 30, 2024
@nguyenalex836
Copy link
Contributor

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

Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

Many thanks for reporting back on your discoveries about the git:// protocol and proposing a useful alternative for users. It's much appreciated 💖

I'm suggesting that we move the information directly into the table. However, before we merge any updates, we should follow up internally because it feels as if the output of github.repositoryUrl should have been updated when we turned off the git:// protocol.

@felicitymay felicitymay added the needs SME This proposal needs review from a subject matter expert label Jan 2, 2025
Copy link
Contributor

github-actions bot commented Jan 2, 2025

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@lachieh
Copy link
Contributor Author

lachieh commented Jan 2, 2025

Thanks, @felicitymay!

it feels as if the output of github.repositoryUrl should have been updated when we turned off the git:// protocol.

I'm going to assume that the output was not modified because it can still be used for string comparison despite it not working for git operations. It seems like it is still used a fair bit.

In most cases, the actions/checkout action is enough as it configures the runner with the correct remote URL anyway. I needed the https URL for a different 3rd-party action and had to dig a bit to work out why the github.repositoryUrl wasn't working specifically for git operations. I just didn't want others to waste time following the same path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants