fix input handling #357

mjpieters · 2023-03-30T13:58:18Z

This PR fixes how github-script handles the inputs given, which in turn
unbreaks how the Octokit request defaults are set.

I've included an extra ESLint rule to guard against the error in future, as
well as expanded the integration tests to cover action settings better.

Clean and spruce up the integration tests a bit
- Use test-specific step ids
- Remove unused input parameters
- Provide clear output on what passed or failed, including a step summary for each passed test.
Fix null handling, covered by integration tests
- core.getInput() always returns a string, so testing for 'not null' is always true. This then leads to previews set to an array with a single empty string, breaking accept-header output.
- Updated eslint rules should help avoid this issue in future, and new integration tests verify that the github client configuration now reflects the intended configuration options.

Fixes #243

mjpieters · 2023-03-30T15:39:10Z

See https://github.com/actions/github-script/actions/runs/4611973839 for an example of what the integration test summaries look like.

- Use test-specific step ids - Remove unused input parameters - Provide clear output on what passed or failed, including a step summary for each passed test.

src/main.ts

joshmgross

Left one suggestion, but not a blocker. Thanks for adding all those integration tests!

`core.getInput()` always returns a string, so testing for 'not null' is always true. This then leads to previews set to an array with a single empty string, breaking accept-header output. Updated eslint rules should help avoid this issue in future, and new integration tests verify that the github client configuration now reflects the intended configuration options.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) #### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) #### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/JoshuaKGoldberg/template-typescript-node-package).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) ##### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) ##### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/JoshuaKGoldberg/ts-api-utils).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) ##### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) ##### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/JellyfishSDK/jellyfish).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script (actions/github-script)</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) #### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) #### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/Hapag-Lloyd/terraform-aws-bastion-host-ssm).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script (actions/github-script)</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) #### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) #### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/Hapag-Lloyd/dist-comm-vis).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Bumps [actions/github-script](https://github.com/actions/github-script) from 6.4.0 to 7.0.1. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/github- script/releases">actions/github-script's releases</a>.</em></p> <blockquote> <h2>v7.0.1</h2> <h2>What's Changed</h2> <ul> <li>Avoid setting <code>baseUrl</code> to undefined when input is not provided by <a href="https://github.com/joshmgross"><code>@joshmgross</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/439">actions/github-script#439</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/github- script/compare/v7.0.0...v7.0.1">https://github.com/actions/github- script/compare/v7.0.0...v7.0.1</a></p> <h2>v7.0.0</h2> <h2>What's Changed</h2> <ul> <li>Add base-url option by <a href="https://github.com/robandpdx"><code>@robandpdx</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/429">actions/github-script#429</a></li> <li>Expose async-function argument type by <a href="https://github.com/viktorlott"><code>@viktorlott</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/402">actions/github-script#402</a>, see for details <a href="https://github.com/actions/github-script#use-scripts-with-jsdoc- support">https://github.com/actions/github-script#use-scripts-with- jsdoc-support</a></li> <li>Update dependencies and use Node 20 by <a href="https://github.com/joshmgross"><code>@joshmgross</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/425">actions/github-script#425</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/navarroaxel"><code>@navarroaxel</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/285">actions/github-script#285</a></li> <li><a href="https://github.com/robandpdx"><code>@robandpdx</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/429">actions/github-script#429</a></li> <li><a href="https://github.com/viktorlott"><code>@viktorlott</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/402">actions/github-script#402</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/github- script/compare/v6.4.1...v7.0.0">https://github.com/actions/github- script/compare/v6.4.1...v7.0.0</a></p> <h2>v6.4.1</h2> <h2>What's Changed</h2> <ul> <li>Add <code>@octokit/plugin-request-log</code>, to produce debug output for requests by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/358">actions/github-script#358</a></li> <li>fix input handling by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/357">actions/github-script#357</a></li> <li>Remove unused dependencies by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/356">actions/github-script#356</a></li> <li>Default debug to current runner debug state by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/363">actions/github-script#363</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/mjpieters"><code>@mjpieters</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/358">actions/github-script#358</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/github- script/compare/v6.4.0...v6.4.1">https://github.com/actions/github- script/compare/v6.4.0...v6.4.1</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="actions/github-script@60a0d83039c 74a4aee543508d2ffcb1c3799cdea"><code>60a0d83</code></a> Merge pull request <a href="https://redirect.github.com/actions/github- script/issues/440">sagemath#440</a> from actions/joshmgross/v7.0.1</li> <li><a href="actions/github-script@b7fb2001b41 0c9390cbe9e2c7d5cab7eefb7b29c"><code>b7fb200</code></a> Update version to 7.0.1</li> <li><a href="actions/github-script@12e22ed06b6 cf302663f90a925045516e24c8bad"><code>12e22ed</code></a> Merge pull request <a href="https://redirect.github.com/actions/github- script/issues/439">sagemath#439</a> from actions/joshmgross/avoid-setting-base- url</li> <li><a href="actions/github-script@d319f8f5b55 ea40916b869b2ca9ae2f059c60abf"><code>d319f8f</code></a> Avoid setting <code>baseUrl</code> to undefined when input is not provided</li> <li><a href="actions/github-script@e69ef5462fd 455e02edcaf4dd7708eda96b9eda0"><code>e69ef54</code></a> Merge pull request <a href="https://redirect.github.com/actions/github- script/issues/425">sagemath#425</a> from actions/joshmgross/node-20</li> <li><a href="actions/github-script@ee0914b839b 704083a749f8c77a73a9270674a32"><code>ee0914b</code></a> Update licenses</li> <li><a href="actions/github-script@d6fc56f33b0 17d55917d045da1a94efa2120f039"><code>d6fc56f</code></a> Use <code>@types/node</code> for Node 20</li> <li><a href="actions/github-script@384d6cf5814 52587d1e31f553c97ab165427124a"><code>384d6cf</code></a> Fix quotations in tests</li> <li><a href="actions/github-script@84724927e3e 992f17768c17f57a47a85ea2a5160"><code>8472492</code></a> Only validate GraphQL <code>previews</code></li> <li><a href="actions/github-script@84903f51828 821af5d03d3884c6ba699a2d44d6e"><code>84903f5</code></a> Remove <code>node-fetch</code> from type</li> <li>Additional commits viewable in <a href="https://github.com/actions/github- script/compare/v6.4.0...v7.0.1">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot- badges.githubapp.com/badges/compatibility_score?dependency- name=actions/github-script&package-manager=github_actions&previous- version=6.4.0&new- version=7.0.1)](https://docs.github.com/en/github/managing-security- vulnerabilities/about-dependabot-security-updates#about-compatibility- scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> URL: sagemath#36739 Reported by: dependabot[bot] Reviewer(s): Kwankyu Lee

mjpieters requested a review from a team March 30, 2023 13:58

Clean and spruce up the integration tests a bit

806be26

- Use test-specific step ids - Remove unused input parameters - Provide clear output on what passed or failed, including a step summary for each passed test.

joshmgross reviewed Apr 4, 2023

View reviewed changes

src/main.ts Outdated Show resolved Hide resolved

joshmgross approved these changes Apr 4, 2023

View reviewed changes

joshmgross merged commit f1ab577 into actions:main Apr 4, 2023

mjpieters deleted the fix_input_handling branch April 5, 2023 07:54

psobolewskiPhD mentioned this pull request Mar 24, 2024

[Maint] fix benchmarks_report workflow: ensure artifactName matches the uploaded artifact name napari/napari#6773

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix input handling #357

fix input handling #357

mjpieters commented Mar 30, 2023 •

edited

Loading

mjpieters commented Mar 30, 2023 •

edited

Loading

joshmgross left a comment

fix input handling #357

fix input handling #357

Conversation

mjpieters commented Mar 30, 2023 • edited Loading

mjpieters commented Mar 30, 2023 • edited Loading

joshmgross left a comment

Choose a reason for hiding this comment

mjpieters commented Mar 30, 2023 •

edited

Loading

mjpieters commented Mar 30, 2023 •

edited

Loading