clarify: "The audit command is only supported when using an organization account."

[jsoref]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/migrating-to-github-actions/automated-migrations/migrating-from-circleci-with-github-actions-importer#limitations

What part(s) of the article would you like to see updated?

• The audit command is only supported when using an organization account. However, the dry-run and migrate commands can be used with an organization or user account.

There are two platforms involved in migrating from circleci to GitHub:

1. circleci
2. GitHub

It is not clear whether this bullet point is talking about the former or the latter. If it's talking about the latter, it should really have explain how/where to provide an "organization account". If it's talking about the former, it should do the same. -- I've been a user of github for a fairly long time and while I am an owner of many organizations, I can't figure out what this would mean in github terms. organization-accounts are things in github, but you can't log in with them -- you log in as a user that is a member of an organization.

Additional information

No response

[nguyenalex836]

@jsoref Thanks for opening an issue! I'll get this triaged for review ✨

[felicitymay]

Hi @jsoref 👋🏻

• The audit command is only supported when using an organization account. However, the dry-run and migrate commands can be used with an organization or user account.
  There are two platforms involved in migrating from circleci to GitHub:

1. circleci
2. GitHub

It is not clear whether this bullet point is talking about the former or the latter. If it's talking about the latter, it should really have explain how/where to provide an "organization account". If it's talking about the former, it should do the same. -- I've been a user of github for a fairly long time and while I am an owner of many organizations, I can't figure out what this would mean in github terms. organization-accounts are things in github, but you can't log in with them -- you log in as a user that is a member of an organization.

I agree that the bullet point that you've highlighted is unclear.

I can confirm that the bullet is referring to use of the GitHub Actions Importer. It sounds as if you need to be a GitHub user who is part of an organization to create a PAT that can be used to run the audit command, but this is worth checking on. I'm going to request an SME review to get clarity on this.

[github-actions]

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

[nguyenalex836]

@jsoref Thank you for your patience while our SME team reviewed! 💛 They confirmed CircleCI organization accounts are being referenced here.

We should update the doc to be explicit that the following phrase is talking about CircleCI accounts:

• The audit command is only supported when using an organization account. However, the dry-run and migrate commands can be used with an organization or user account.

Would be clearer as:

• The audit command is only supported when you use a CircleCI organization account. The dry-run and migrate commands can be used with a CircleCI organization or user account.

I've added the help wanted label so that you, or anyone else, may open a PR for this update ✨ thanks again for raising this issue!