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

add note about restarting the runner service after changing the .env … #35356

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

christianspecht
Copy link

@christianspecht christianspecht commented Nov 19, 2024

…file

Why:

Because I spent about half an hour scratching my head why my script defined in the .env file was not executed, until I had the idea to restart the runner service.
I assumed that the runner read the file before each job run, IMO it's not obvious that it only happens after restarting.

IMO it's not obvious that the runner only reads the file after restarting, I assumed that it happens before each job run.

Closes:

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

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Nov 19, 2024

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 Nov 19, 2024
Copy link
Contributor

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/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job.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

@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 Nov 20, 2024
@nguyenalex836
Copy link
Contributor

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

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Nov 22, 2024
Copy link
Contributor

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

@Sanasahil

This comment was marked as spam.

@nguyenalex836 nguyenalex836 added SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Dec 13, 2024
@nguyenalex836
Copy link
Contributor

@christianspecht Thank you so much for your patience while our SME team reviewed! 💛 They thanked you for the PR, and offered the following guidance -

Might be better to consider adding just a sentence to the paragraph on line 52 or a new line before the note on 58 to remind users that any change to the .env file will require restarting the runner.

Please let us know if you'd be willing to update your PR to match this guidance - thank you ✨

@Mohamezezo

This comment was marked as spam.

@nguyenalex836 nguyenalex836 added the more-information-needed More information is needed to complete review label Dec 18, 2024
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 more-information-needed More information is needed to complete review SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants