jiriks74/create-pull-request
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Peter Evans 2019-08-13 17:00:59 +09:00
parent 964fc3cdf1
commit 9efd6de49c
1 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -13,13 +13,19 @@ Create Pull Request action will:
2. Commit all changes to a new branch. The commit will be made using the name and email of the `HEAD` commit author. 2. Commit all changes to a new branch. The commit will be made using the name and email of the `HEAD` commit author.
3. Create a pull request to merge the new branch into the currently active branch executing the workflow. 3. Create a pull request to merge the new branch into the currently active branch executing the workflow.
Note: In general, it's not good practice to modify your repository during workflows.
This action is experimental and may not work well for repositories that have a very high frequency of commits.
## Usage ## Usage
```hcl The default `GITHUB_TOKEN` does not have the access neccessary for this action to work correctly.
action "Create Pull Request" { Create a new `repo` scoped token [here](https://github.com/settings/tokens) and pass that as a secret to the `REPO_ACCESS_TOKEN` environment variable.
uses = "peter-evans/create-pull-request@v1.0.0"
secrets = ["GITHUB_TOKEN"] ```yml
} - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.0.0
env:
REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
``` ```
#### Environment variables #### Environment variables
@ -50,17 +56,15 @@ If there are files or directories you want to ignore you can simply add them to
Here is an example that sets all the environment variables. Here is an example that sets all the environment variables.
```hcl ```yml
action "Create Pull Request" { - name: Create Pull Request
uses = "peter-evans/create-pull-request@v1.0.0" uses: peter-evans/create-pull-request@v1.0.0
secrets = ["GITHUB_TOKEN"] env:
env = { REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
PULL_REQUEST_BRANCH = "my-patches" PULL_REQUEST_BRANCH: my-patches
COMMIT_MESSAGE = "Auto-modify files by my-file-modifier-action" COMMIT_MESSAGE: Auto-modify files by my-file-modifier-action
PULL_REQUEST_TITLE = "Changes from my-file-modifier-action" PULL_REQUEST_TITLE: Changes from my-file-modifier-action
PULL_REQUEST_BODY = "This is an auto-generated PR with changes from my-file-modifier-action" PULL_REQUEST_BODY: This is an auto-generated PR with changes from my-file-modifier-action
}
}
``` ```
This configuration will create pull requests that look like this: This configuration will create pull requests that look like this: