Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type for /complete data #96

Merged
merged 6 commits into from
Jul 25, 2023
Merged

Add type for /complete data #96

merged 6 commits into from
Jul 25, 2023

Conversation

mmcqd
Copy link
Member

@mmcqd mmcqd commented Jul 20, 2023

All the optional fields are new since 0.123.0

0.123.0 data: https://github.com/returntocorp/semgrep/blob/084ff5f16866ab66337655dbc06672e05d3089dc/cli/src/semgrep/app/scans.py#L301

Current data: https://github.com/returntocorp/semgrep/blob/develop/cli/src/semgrep/app/scans.py#L320

  • I ran make setup && make to update the generated code after editing a .atd file (TODO: have a CI check)

semgrep_output_v1.atd Show resolved Hide resolved
semgrep_output_v1.atd Outdated Show resolved Hide resolved
semgrep_output_v1.atd Outdated Show resolved Hide resolved
semgrep_output_v1.atd Show resolved Hide resolved
semgrep_output_v1.atd Show resolved Hide resolved
@aryx
Copy link
Collaborator

aryx commented Jul 25, 2023

I see the PR reference /complete but the .atd does not talk about it.
Maybe we could add comments in the .atd for the different "entry" types and specify
to which endpoint they correspond to?

@mmcqd
Copy link
Member Author

mmcqd commented Jul 25, 2023

I see the PR reference /complete but the .atd does not talk about it. Maybe we could add comments in the .atd for the different "entry" types and specify to which endpoint they correspond to?

Done

@mmcqd mmcqd merged commit 407f582 into main Jul 25, 2023
mmcqd added a commit to semgrep/semgrep that referenced this pull request Jul 25, 2023
This PR adds an ATD type for the data being sent to the `/complete`
endpoint of the app. An app PR doing the same will follow.

Depends on: semgrep/semgrep-interfaces#96

PR checklist:

- [x] Purpose of the code is [evident to future
readers](https://semgrep.dev/docs/contributing/contributing-code/#explaining-code)
- [x] Tests included or PR comment includes a reproducible test plan
- [x] Documentation is up-to-date
- [x] A changelog entry was [added to
changelog.d](https://semgrep.dev/docs/contributing/contributing-code/#adding-a-changelog-entry)
for any user-facing change
- [x] Change has no security implications (otherwise, ping security
team)

If you're unsure about any of this, please see:

- [Contribution
guidelines](https://semgrep.dev/docs/contributing/contributing-code)!
- [One of the more specific guides located
here](https://semgrep.dev/docs/contributing/contributing/)

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
@aryx
Copy link
Collaborator

aryx commented Jul 26, 2023

You should talk with @mjambon when he is back from vacation about your ideas for improving ATD.

@mjambon mjambon deleted the matthew/ci_scan_complete branch August 30, 2023 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants