Skip to content

docs: update README environment parameter examples - #401

Open
curry-battle wants to merge 1 commit into
cloudflare:mainfrom
curry-battle:fix/readme-env-example
Open

docs: update README environment parameter examples#401
curry-battle wants to merge 1 commit into
cloudflare:mainfrom
curry-battle:fix/readme-env-example

Conversation

@curry-battle

Copy link
Copy Markdown

Summary

  • Update README examples to use environment parameter instead of --env flag in command
  • This provides clearer guidance on the recommended way to specify environments

Changes

  • Updated workflow dispatch example to use separate environment parameter
  • Updated secrets example to use separate environment parameter instead of inline --env flag

Comment thread README.md
Comment on lines 270 to 274
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
command: deploy --env production
command: deploy
secrets: |
SUPER_SECRET
environment: production

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While the previous examples with --env flag work correctly (the flag takes precedence when both are specified as per wranglerAction.ts#L321-L323), using the dedicated environment parameter is simpler.

@curry-battle
curry-battle marked this pull request as ready for review December 23, 2025 12:09
@curry-battle
curry-battle requested review from a team as code owners December 23, 2025 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant