Skip to content

Commit

Permalink
docs(user): Inform users how to use user info
Browse files Browse the repository at this point in the history
`user_name` and `user_email` are new feature to change a user.
  • Loading branch information
5ouma committed Feb 14, 2024
1 parent 19acb8d commit 8da1e56
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ The Action will extract all needed informations by itself, you just need to spec
with:
# Required, custom GitHub access token with the 'public_repo' and 'workflow' scopes
token: ${{secrets.TOKEN}}
# Optional, will commit with this user name
user_name: name
# Optional, will commit with this user email
user_email: email@example.com
# Optional, will create tap repo fork in organization
org: ORG
# Optional, use the origin repository instead of forking
Expand Down Expand Up @@ -61,6 +65,10 @@ If there are no outdated formulae, the Action will just exit.
with:
# Required, custom personal GitHub access token with only the 'public_repo' scope enabled
token: ${{secrets.CUSTOM_PERSONAL_ACCESS_TOKEN}}
# Optional, will commit with this user name
user_name: user_name
# Optional, will commit with this user email
user_email: email@example.com
# Optional, will create tap repo fork in organization
org: ORG
# Bump all outdated formulae in this tap
Expand Down

0 comments on commit 8da1e56

Please sign in to comment.