cloudflare / pages-action

MIT License
468 stars 95 forks source link

Make GitHub deployments opt-out, not opt-in #69

Closed aaronadamsCA closed 4 weeks ago

aaronadamsCA commented 1 year ago

To enable GitHub deployments and deployment statuses today, you need to pass in your GitHub token manually:

          # Optional: Enable this if you want to have GitHub Deployments triggered
          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

IMO this is a bad API for a few reasons:

I'd like to suggest the following changes:

With these changes, a subset of users could still disable deployment statuses or override the GitHub token, but everyone else would benefit from simpler setup with more default features.

I'm happy to contribute this change if it's desired. I expect it would require a major version bump.

nprogers commented 1 month ago

@aaronadamsCA Thanks for your suggestion! We're working on deprecating this repo, and moving everything to wrangler-action. We're tracking deployments support here, although I'm not sure yet that we'll be switching to opt-out vs opt-in.

aaronadamsCA commented 4 weeks ago

That's great @nprogers, I'll close this and add a note over there that (whether opt-in or opt-out) the deployment feature should be controlled using a boolean, since actions can always access github.token.