Rename a GitHub Action on the Marketplace #27118

wouter-admiraal-sonarsource · 2021-05-14T15:09:03Z

wouter-admiraal-sonarsource
May 14, 2021

Hi all,

We’re about to publish a GitHub Action to the Marketplace, but are unsure about the (human readable) name. Once we publish our action to the Marketplace, can we still change the name in the action.yml file, and will this be reflected in the Marketplace? Or is the name set in stone the first time it’s published? Note that we will not change the repo slug, which will remain the same regardless of our naming strategy. I’m only speaking about the name property of the action.yml file.

Thanks for your help!

Answered by jsoref

May 23, 2021

Changing the name in the yaml will change the url in the marketplace:

github.com/desbo/merge-pr-action

Action name misspells `dependency`

<div class="github-info">
  <div class="date">
    opened <span class="discourse-local-date" data-format="ll" data-date="2021-05-20" data-time="09:35:20" data-timezone="UTC">09:35AM - 20 May 21 UTC</span>
  </div>

    <div class="date">
      closed <span class="discourse-local-date" data-format="ll" data-date="2021-05-20" data-time="15:28:11" data-timezone="UTC">03:28PM - 20 May 21 UTC</span>
    </div>

  <div class="user">
    <a href="https://github.com/jsoref" target="_blank" rel="noopener nofollow ugc">
      <img alt="jsoref" src="https://…

View full answer

jsoref · 2021-05-23T15:10:59Z

jsoref
May 23, 2021

Changing the name in the yaml will change the url in the marketplace:

github.com/desbo/merge-pr-action

Action name misspells `dependency`

<div class="github-info">
  <div class="date">
    opened <span class="discourse-local-date" data-format="ll" data-date="2021-05-20" data-time="09:35:20" data-timezone="UTC">09:35AM - 20 May 21 UTC</span>
  </div>

    <div class="date">
      closed <span class="discourse-local-date" data-format="ll" data-date="2021-05-20" data-time="15:28:11" data-timezone="UTC">03:28PM - 20 May 21 UTC</span>
    </div>

  <div class="user">
    <a href="https://github.com/jsoref" target="_blank" rel="noopener nofollow ugc">
      <img alt="jsoref" src="https://user-images.githubusercontent.com/2119212/181101775-df7f8c33-2a3f-4deb-bd6d-178be1b3f0cc.png" class="onebox-avatar-inline" width="20" height="20">
      jsoref
    </a>
  </div>
</div>

<div class="labels">
</div>

https://github.com/desbo/merge-pr-action/blob/e5cd901e774423f1087298b4c3479b659b…d1f0f9/action.yml#L1

Consumers are tied to the org+repository name and not the pretty name, so, it’s mostly not a huge deal, unless you have a lot of people linking to the marketplace url.

Do note that org/org or user/user is now a magical repository name, so while that may have been the logical choice for an action, it’s now not a good idea. Thus, org/org-action may be a better choice.

Less is more – 11 Jul 20

Create a special repository in your GitHub Profile 🔨

How to add README.md to GitHub Profile? What features are supported and which are not?

Also note that renaming your default branch will break consumers, so if you plan to switch from master to main, it’s a good idea to do so before you advertise. GitHub’s magical rename feature does not support this.

0 replies

wouter-admiraal-sonarsource · 2021-05-25T06:33:26Z

wouter-admiraal-sonarsource
May 25, 2021
Author

Thanks for the answer, and the link 👍

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

Rename a GitHub Action on the Marketplace #27118

{{title}}

Replies: 2 comments

{{title}}

Action name misspells `dependency`

{{title}}

Select a reply

Navigation Menu

GitHub Community

Rename a GitHub Action on the Marketplace #27118

wouter-admiraal-sonarsource May 14, 2021

Action name misspells `dependency`

Replies: 2 comments

jsoref May 23, 2021

Action name misspells `dependency`

Create a special repository in your GitHub Profile 🔨

wouter-admiraal-sonarsource May 25, 2021 Author

wouter-admiraal-sonarsource
May 14, 2021

jsoref
May 23, 2021

wouter-admiraal-sonarsource
May 25, 2021
Author