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

fix(iac):pass allow analytics flag to snyk-iac-test [IAC-3017] #5484

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ioannacaba
Copy link

@ioannacaba ioannacaba commented Sep 13, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , 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.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

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 affecting package-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?

We need to have the info if analytics are allowed or not in snyk-iac-test. This change passes to snyk-iac-test this boolean flag (AllowAnalytics).

What are the relevant tickets?

@ioannacaba ioannacaba requested a review from a team as a code owner September 13, 2024 08:07
Copy link
Contributor

github-actions bot commented Sep 13, 2024

Warnings
⚠️

You've modified files in src/ directory, but haven't updated anything in test folder. Is there something that could be tested?

Generated by 🚫 dangerJS against c4b1435

@ioannacaba ioannacaba force-pushed the feat/IAC-3017/pass-allow-analytics branch from 6098837 to c4b1435 Compare September 13, 2024 08:15
@ioannacaba ioannacaba self-assigned this Sep 13, 2024
@andreeaneata
Copy link
Contributor

Can the PR title + the commit be: fix(iac): .... instead?

@@ -129,6 +130,10 @@ function processFlags(
// required for infrastructureAsCodeSuccesses to be populated
flags.push('-include-passed-vulnerabilities');

if (analytics.allowAnalytics()) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR should be a draft for now as it's not complete. Only passing the flag is not enough, the snyk-iac-test version needs to also be upgraded to the version resulted from the release from snyk-iac-test.

The upgrade lines will go here:

const policyEngineChecksums = `
102442f1a622c4006207b5fb3822ea493000fe711beeb1341359f14057872b67 snyk-iac-test_0.54.0_Darwin_arm64
11cc1ed464380932cf46551a1a1eb8fbaea0cae2da0853b7dccbe58d872bc44e snyk-iac-test_0.54.0_Linux_arm64
238cb88c2315d9bcca9a7f9a277934074f50902fdd595572cd739f4601b25ed1 snyk-iac-test_0.54.0_Linux_x86_64
487291b0193f3ed1a6647c631dfaa401faa81509d6c7fa328e1f29296115668b snyk-iac-test_0.54.0_Darwin_x86_64
c94f91823e135c9e585bb41e5c274116001f079a28865a62e19ff9c8688a88e0 snyk-iac-test_0.54.0_Windows_x86_64.exe
`;

@ioannacaba ioannacaba changed the title pass allow analytics flag to snyk-iac-test [IAC-3017] fix(iac):pass allow analytics flag to snyk-iac-test [IAC-3017] Sep 13, 2024
@ioannacaba ioannacaba marked this pull request as draft September 13, 2024 10:29
@ioannacaba ioannacaba marked this pull request as draft September 13, 2024 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants