diff --git a/README.md b/README.md index 3f15015..d1dc1a2 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ GitHub Action for creating Cloudflare Pages deployments, using the new [Direct U directory: YOUR_ASSET_DIRECTORY # Optional: Enable this if you want to have GitHub Deployments triggered gitHubToken: ${{ secrets.GITHUB_TOKEN }} + # Optional: Set a branch name to override the current branch name + branch: YOUR_BRANCH_NAME ``` 1. Replace `YOUR_ACCOUNT_ID`, `YOUR_PROJECT_NAME` and `YOUR_ASSET_DIRECTORY` with the appropriate values to your Pages project. @@ -65,6 +67,8 @@ The branch name is used by Cloudflare Pages to determine if the deployment is pr If you are in a Git workspace, Wrangler will automatically pull the branch information for you. You can override this manually by adding the argument `branch: YOUR_BRANCH_NAME`. +When using a branch other than `main` for your production branch, you must set `branch: main` in your workflow to ensure that the deployment is published to the production environment. + ### Specifying a working directory By default Wrangler will run in the root package directory. If your app lives in a monorepo and you want to run Wrangler from its directory, add `workingDirectory: YOUR_PACKAGE_DIRECTORY`.