Add path input

README.md

@@ -33,15 +33,17 @@ Create Pull Request action will:
 
 You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format `@v2.x.x`
 
+### Action inputs
+
+With the exception of `token`, all inputs are **optional**. If not set, sensible default values will be used.
+
 **Note**: If you want pull requests created by this action to trigger an `on: pull_request` workflow then you must use a [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) instead of the default `GITHUB_TOKEN`.
 See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) for further details.
 
-### Action inputs
-
-These inputs are *all optional*. If not set, sensible default values will be used.
-
 | Name | Description | Default |
 | --- | --- | --- |
+| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
+| `path` | Relative path under `$GITHUB_WORKSPACE` to the repository. | `$GITHUB_WORKSPACE` |
 | `commit-message` | The message to use when committing changes. | `[create-pull-request] automated change` |
 | `committer` | The committer name and email address in the format `Display Name <email@address.com>`. | Defaults to the GitHub Actions bot user. See [Committer and author](#committer-and-author) for details. |
 | `author` | The author name and email address in the format `Display Name <email@address.com>`. | Defaults to the GitHub Actions bot user. See [Committer and author](#committer-and-author) for details. |

action.yml

@@ -2,8 +2,10 @@ name: 'Create Pull Request'
 description: 'Creates a pull request for changes to your repository in the actions workspace'
 inputs:
   token:
-    description: 'The GitHub authentication token'
+    description: 'GITHUB_TOKEN or a repo scoped PAT'
     required: true
+  path:
+    description: 'Relative path under $GITHUB_WORKSPACE to the repository.'
   commit-message:
     description: 'The message to use when committing changes.'
   committer:

dist/index.js

@@ -1024,6 +1024,7 @@ async function run() {
     // Fetch action inputs
     const inputs = {
       token: core.getInput("token"),
+      path: core.getInput("path"),
       commitMessage: core.getInput("commit-message"),
       committer: core.getInput("committer"),
       author: core.getInput("author"),
@@ -1044,6 +1045,7 @@ async function run() {
 
     // Set environment variables from inputs.
     if (inputs.token) process.env.GITHUB_TOKEN = inputs.token;
+    if (inputs.path) process.env.CPR_PATH = inputs.path;
     if (inputs.commitMessage) process.env.CPR_COMMIT_MESSAGE = inputs.commitMessage;
     if (inputs.committer) process.env.CPR_COMMITTER = inputs.committer;
     if (inputs.author) process.env.CPR_AUTHOR = inputs.author;

dist/src/create_pull_request.py

@@ -96,6 +96,7 @@ def set_committer_author(repo, committer, author):
 github_token = os.environ["GITHUB_TOKEN"]
 github_repository = os.environ["GITHUB_REPOSITORY"]
 # Get environment variables with defaults
+path = os.getenv("CPR_PATH", os.getcwd())
 branch = os.getenv("CPR_BRANCH", DEFAULT_BRANCH)
 commit_message = os.getenv("CPR_COMMIT_MESSAGE", DEFAULT_COMMIT_MESSAGE)
 # Get environment variables with a default of 'None'
@@ -103,8 +104,8 @@ committer = os.environ.get("CPR_COMMITTER")
 author = os.environ.get("CPR_AUTHOR")
 base = os.environ.get("CPR_BASE")
 
-# Set the repo to the working directory
+# Set the repo path
-repo = Repo(os.getcwd())
+repo = Repo(path)
 
 # Determine if the checked out ref is a valid base for a pull request
 # The action needs the checked out HEAD ref to be a branch

index.js

@@ -22,6 +22,7 @@ async function run() {
     // Fetch action inputs
     const inputs = {
       token: core.getInput("token"),
+      path: core.getInput("path"),
       commitMessage: core.getInput("commit-message"),
       committer: core.getInput("committer"),
       author: core.getInput("author"),
@@ -42,6 +43,7 @@ async function run() {
 
     // Set environment variables from inputs.
     if (inputs.token) process.env.GITHUB_TOKEN = inputs.token;
+    if (inputs.path) process.env.CPR_PATH = inputs.path;
     if (inputs.commitMessage) process.env.CPR_COMMIT_MESSAGE = inputs.commitMessage;
     if (inputs.committer) process.env.CPR_COMMITTER = inputs.committer;
     if (inputs.author) process.env.CPR_AUTHOR = inputs.author;

src/create_pull_request.py

@@ -96,6 +96,7 @@ def set_committer_author(repo, committer, author):
 github_token = os.environ["GITHUB_TOKEN"]
 github_repository = os.environ["GITHUB_REPOSITORY"]
 # Get environment variables with defaults
+path = os.getenv("CPR_PATH", os.getcwd())
 branch = os.getenv("CPR_BRANCH", DEFAULT_BRANCH)
 commit_message = os.getenv("CPR_COMMIT_MESSAGE", DEFAULT_COMMIT_MESSAGE)
 # Get environment variables with a default of 'None'
@@ -103,8 +104,8 @@ committer = os.environ.get("CPR_COMMITTER")
 author = os.environ.get("CPR_AUTHOR")
 base = os.environ.get("CPR_BASE")
 
-# Set the repo to the working directory
+# Set the repo path
-repo = Repo(os.getcwd())
+repo = Repo(path)
 
 # Determine if the checked out ref is a valid base for a pull request
 # The action needs the checked out HEAD ref to be a branch