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

example for self-hosted runners in the wild #9015

Merged
merged 10 commits into from
Dec 14, 2021
Merged

Conversation

grenade
Copy link
Contributor

@grenade grenade commented Aug 13, 2021

there are probably no examples of self-hosted runners whose service name is actions.runner.octo-org-octo-repo.runner01.service outside of octo-org.

the other problem with the current docs is the suggestion to use cat ~/actions-runner/.service to determine the service name. obviously this only works if the installation path was ~/actions-runner/.service which is only ever going to be coincidentally correct.

this change includes a command example that works in the wild and is based on using systemctl --type=service | grep actions.runner to determine the service name which is generally going to work (if the user has managed to gt the service running).

Why:

Closes [issue link]

What's being changed:

Check off the following:

  • I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click View deployment).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

there are probably no examples of self-hosted runners whose service name is `actions.runner.octo-org-octo-repo.runner01.service` outside of octo-org.

this change includes a command example that works in the wild.
@welcome
Copy link

welcome bot commented Aug 13, 2021

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 13, 2021
@ramyaparimi ramyaparimi added 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 Aug 13, 2021
@ramyaparimi
Copy link
Contributor

@grenade
Thanks so much for opening a PR! I got this triaged for review ⚡

@ramyaparimi ramyaparimi 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 labels Aug 23, 2021
@martin389 martin389 assigned martin389 and unassigned martin389 Nov 10, 2021
Copy link
Contributor

@hubwriter hubwriter left a comment

Choose a reason for hiding this comment

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

@grenade - Many thanks for taking the time to make this improvement to the GitHub docs. Much appreciated. 👍

Apologies it's taken a while to get round to reviewing this. You make a good point here and this is a good improvement. Thanks again for your input.

I've suggested some very small changes, which hopefully you're okay with. If you're happy to commit these suggestions we can get this merged and published.

Thanks once again. 🎖

@github github deleted a comment Nov 29, 2021
@hubwriter
Copy link
Contributor

After some discussion about this internally here at GitHub, I'm going to omit the second part of the changes proposed in this pull request (i.e. the additional journalctl and systemctl commands in the code blocks on lines 70 and 207).

Introducing an example org/repo and then using that example throughout the article is consistent with our other docs and hasn't been difficult for readers to switch in their own org/repo names for the example ones (in this case octo-org and octo-repo).

I'll make these changes in this PR so that I can merge the other changes.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 14, 2021

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 Staging Production What Changed
content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md Modified Original

@hubwriter hubwriter enabled auto-merge (squash) December 14, 2021 09:32
@hubwriter hubwriter merged commit 0735041 into github:main Dec 14, 2021
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 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.

4 participants