-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: Add README for set-github-user and add repository input
Document the usage of the set-github-user action and allow to specify the to be used repository.
- Loading branch information
1 parent
768f487
commit 7637f1c
Showing
2 changed files
with
39 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Setup GitHub User in a Repository | ||
|
||
GitHub Action to setup the user for a repository. Can be used to push content | ||
to GitHub. | ||
|
||
## Example | ||
|
||
```yml | ||
name: Setup GitHub User | ||
|
||
on: | ||
pull_request: | ||
|
||
jobs: | ||
setup-pontos: | ||
name: Setup | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: greenbone/actions/setup-github-user@v2 | ||
with: | ||
user: ${{ vars.user }} | ||
mail: ${{ vars.mail }} | ||
token: ${{ secrets.TOKEN }} | ||
|
||
``` | ||
|
||
## Action Configuration | ||
|
||
|Input Variable|Description| | | ||
|--------------|-----------|-| | ||
| user | GitHub user name on behalf of whom the actions will be executed. | Required | | ||
| mail | Mail address for the given GitHub user. | Required | | ||
| token | The GitHub user's token (PAT) | Optional (default: `${{ github.token }}`) | | ||
| repository | GitHub repository to use | Optional (default: `${{ github.repository }}`) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters