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.

Sign up for GitHub

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

Jump to bottom

docs: Update repo_checks README with additional token info #535

Merged
merged 3 commits into from
Jul 9, 2024
Merged

docs: Update repo_checks README with additional token info #535

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a3c2ac
docs: Update repo_checks README with additional token info
sarina Jul 8, 2024
ed4c01a
docs: Add note in repo_checks README about tagging maintainers in PRs
sarina Jul 8, 2024
a997408
temp: Update edx_repo_tools/repo_checks/README.rst
sarina Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion edx_repo_tools/repo_checks/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
************

Expand Down
Loading