From f87b05df38b99a4550da263402298abfc5db1aa2 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Tue, 9 Jul 2024 07:32:09 -0400 Subject: [PATCH] docs: Update repo_checks README with additional info (#535) * docs: Update repo_checks README with additional token info * docs: Add note in repo_checks README about tagging maintainers in PRs --- edx_repo_tools/repo_checks/README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/edx_repo_tools/repo_checks/README.rst b/edx_repo_tools/repo_checks/README.rst index 14178927..c56c0265 100644 --- a/edx_repo_tools/repo_checks/README.rst +++ b/edx_repo_tools/repo_checks/README.rst @@ -20,7 +20,7 @@ The ``repo_checks`` command line tool lets you execute these checks, either as d Usage ***** -You will need a GH personal access token with the following scopes: +You will need a GH personal access token (classic, not "Fine-grained tokens") with the following scopes: * admin:org * repo @@ -47,6 +47,8 @@ Finally, when you're ready, you can actually apply the fixes to GitHub:: repo_checks --no-dry-run <... same args you used above ...> +Note this will open pull requests in the relevant repos. Some repos intentionally don't have certain workflows (for example, ``docs.openedx.org`` does not use ``commitlint``), so please tag maintainers on the pull requests so they can decide whether or not to use the added or changed workflows. + Contributing ************