-
Notifications
You must be signed in to change notification settings - Fork 567
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
feat(instrumentation): integrate analytics report workflow CLI-302 #5259
feat(instrumentation): integrate analytics report workflow CLI-302 #5259
Conversation
590437f
to
c530396
Compare
c530396
to
731b03d
Compare
fc6369a
to
642a7c3
Compare
3494fa5
to
6a8c787
Compare
cliv2/cmd/cliv2/main.go
Outdated
v2InstrumentationData, | ||
) | ||
|
||
logger.Trace().Msg("Invoking report analytics workflow") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: let's remove the workflow name in logs and comments, the name is not perfect, so let's not spread it more than necessary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right! I changed the logs on that line and around it, I think it's more inline with what we want.
cliv2/cmd/cliv2/main.go
Outdated
) | ||
|
||
if err != nil { | ||
logger.Err(err).Msg("Failed to invoke analytics") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Same as above! Also success and failure logs should use the same wording.
}); | ||
|
||
expect(requests.length).toBeGreaterThan(0); | ||
requests.forEach((req) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: Are these really multiple requests? Looks like before there was only one.
command: 'test', | ||
metadata: { | ||
'upgradable-snyk-protect-paths': 0, | ||
// server.popRequest(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: remove commented code
1f164b1
to
be8e46d
Compare
be8e46d
to
1f97192
Compare
Pull Request Submission
Please check the boxes once done.
The pull request must:
feat:
orfix:
, others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.Pull Request Review
All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.
Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.
For Node projects: It’s important to make sure changes in
package.json
are also affectingpackage-lock.json
correctly.If a dependency is not necessary, don’t add it.
When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.
Pull Request Approval
Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.
What does this PR do?
Where should the reviewer start?
How should this be manually tested?
Any background context you want to provide?
This PR depends on this and this pull requests.
What are the relevant tickets?
Screenshots
Additional questions