-
Notifications
You must be signed in to change notification settings - Fork 62.4k
Renaming repo workflow update #15575 #16144
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
Renaming repo workflow update #15575 #16144
Conversation
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 changesYou 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.
|
@cmwilson21 |
|
||
**Tip:** {% data reusables.organizations.owners-and-admins-can %} rename a repository. {% data reusables.organizations.new-repo-permissions-more-info %} | ||
**Note:** If your repository hosts an action, we recommend that you avoid renaming your repository. The action is not automatically redirected when a workflow runs to avoid security issues, so all workflows that use that action will fail with error `repository not found`. Instead, you can create a new repository with the new name and deprecate the old repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @cmwilson21 - thanks for this update ✨
This looks generally good, but the second sentence is quite long. Can you see a way to break this up so that it's easier to read?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @felicitymay, I revamped the whole thing. Let me know if this sounds alright or if I should go back to tweaking my first note.
Actions will not automatically redirect to a renamed repository. Any workflow that uses that action will fail with the error repository not found
. Instead, create a new repository with the new name and archive the old repository.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @cmwilson21 - I really like your new approach ✨
Compared with your original note, there is just one nuance that I think we need to squeeze in. The fact that this applies to repositories that host an action. How about somewhere in between?
{% data variables.product.prodname %} will not redirect calls to an action hosted by a renamed repository. Any workflow that uses that action will fail with the error
repository not found
. Instead, create a new repository and action with the new name and archive the old repository. For more information, see "Archiving repositories."
This ☝🏻 also changes the link from an inline link (bad for localization) to the format recommended in our style guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@felicitymay This sounds great! I'll update it. Thanks for your direction and help!
refreshed per suggestions
content/repositories/creating-and-managing-repositories/renaming-a-repository.md
Outdated
Show resolved
Hide resolved
…ng-a-repository.md
content/repositories/creating-and-managing-repositories/renaming-a-repository.md
Outdated
Show resolved
Hide resolved
…ng-a-repository.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes and apologies for the typos in my suggestion!
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
Closes 15575
What's being changed:
Changed the tip callout to a note callout per recommendation in the maintainer notes. Updated the language in the note callout to to match the recommended explanation.
Check off the following:
Writer impact (This section is for GitHub staff members only):