Embed client_payload as json to overcome 10 top-level properties limit #204
Conversation
action.yml
Outdated
| embed_payload: | ||
| description: "Instead of event_payload, use a syntetic event object with payload embedded as JSON string, e.g. '{event_payload:<payload_as_json_string>}" | ||
| required: false | ||
| default: "false" |
There was a problem hiding this comment.
I wouldn't set any value as default for optional boolean inputs, it could easily be interpreted as the string "false" which might be interpreted as truthy if not careful.
There was a problem hiding this comment.
Agree, will update PR and remove default value.
README.md
Outdated
| app_id: ${{ secrets.APP_ID }} | ||
| private_key: ${{ secrets.APP_PRIVATE_KEY }} | ||
| dispatch_event_type: my-project-release | ||
| embed: true |
There was a problem hiding this comment.
| embed: true | |
| embed_payload: true |
I would prefer to make it even more explicit and call it embed_payload_as_json_string
| @@ -79,6 +79,27 @@ jobs: | |||
| dispatch_event_type: my-project-release | |||
| ``` | |||
|
|
|||
| If your event has **more than 10** top-level properties, you can embed it in a JSON string `{"event_payload":"<payload_as_json_string>"}` to overcome Github api limits. | |||
There was a problem hiding this comment.
Today I learned about the 10 top level limit! Is this documented somewhere?
There was a problem hiding this comment.
|
Not sure on how to reliably reproduce it. I've found the issue while using your action, just the same way ts being used in https://github.com/octokit/openapi-types.ts/blob/main/.github/workflows/release-notification.yml Maybe you are running against enterprise API. Any ideas? |
|
PR updated :) |
|
I would still like to reproduce it somehow. Maybe we can avoid adding the new option altogether and instead dropping some keys. |
Added option to overcome github limits by embedding event as json string.