Skip to content

Commit

Permalink
tweak instructions around how to deal with hidden parameter warnings …
Browse files Browse the repository at this point in the history
…in generatio nscript readme.
  • Loading branch information
Filip Maj committed Jun 6, 2024
1 parent 3bb52fb commit 3a84dad
Showing 1 changed file with 1 addition and 22 deletions.
23 changes: 1 addition & 22 deletions src/schema/slack/functions/_scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,8 @@ corresponding test, the tests must be removed manually.
> ./generate
```

3. This will output something like the following:
3. For now, the script will only generate warnings if it encounters hidden parameters. If you see warnings around hidden parameters, carefully review the generated output. As much as possible, we want to prevent hidden parameters from being released. At the same time, we have released hidden parameters in this SDK in the past, and so for backwards compatibility reasons, we have kept them in. As such, **ensure no new hidden parameters are introduced**.

```txt
Cleaning folder directory
Generating code & tests for Slack function: add_pin
Generating code & tests for Slack function: add_user_to_usergroup
Generating code & tests for Slack function: archive_channel
Generating code & tests for Slack function: create_channel
Generating code & tests for Slack function: create_usergroup
Generating code & tests for Slack function: delay
Generating code & tests for Slack function: invite_user_to_channel
Generating code & tests for Slack function: open_form
Generating code & tests for Slack function: remove_user_from_usergroup
Generating code & tests for Slack function: reply_in_thread
Generating code & tests for Slack function: send_dm
Generating code & tests for Slack function: send_ephemeral_message
Generating code & tests for Slack function: send_message
Generating code & tests for Slack function: update_channel_topic
Generated 14 Slack functions with their unit tests
Updated functions module export
Formatting Slack function files...
Linting Slack function files...
```

If it completes without any linter errors, you should be good to go, with new,
formatted and linted TypeScript files for all of the Slack functions included in
Expand Down

0 comments on commit 3a84dad

Please sign in to comment.