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: point snyk policy out urls to snyk.io #5338

Merged
merged 7 commits into from
Sep 3, 2024

Conversation

agatakrajewska
Copy link
Contributor

@agatakrajewska agatakrajewska commented Jun 20, 2024

snyk policy output includes the correct url information, udading the url to the snyk.io root rather than security.snyk.io. https://snyksec.atlassian.net/browse/CLI-482

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?

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@agatakrajewska agatakrajewska force-pushed the fix/IGNR-245-fix-broken-license-issue-url branch from 1f646c2 to c4d9d8a Compare June 26, 2024 14:09
@agatakrajewska agatakrajewska marked this pull request as ready for review June 26, 2024 14:11
@agatakrajewska agatakrajewska requested a review from a team as a code owner June 26, 2024 14:11
@agatakrajewska agatakrajewska force-pushed the fix/IGNR-245-fix-broken-license-issue-url branch 11 times, most recently from 748e3f6 to 9ff30da Compare June 27, 2024 08:56
@agatakrajewska agatakrajewska force-pushed the fix/IGNR-245-fix-broken-license-issue-url branch from 9ff30da to 06c79da Compare July 9, 2024 10:21
@oana-andrisoaei-snyk oana-andrisoaei-snyk force-pushed the fix/IGNR-245-fix-broken-license-issue-url branch 3 times, most recently from 1c5c142 to 6b3dc5f Compare August 22, 2024 12:31
@@ -60,3 +60,11 @@ function displayRule(title) {
);
};
}

function apiRoot(vulnId: string) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Question: Will these URLs not/never depend on the user configured instance like eu, au, ...?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think so as I've implemented it based on the logic in registry but let me confirm with the security team, thank you!

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is correct, as it is semi-static data displayed on the un-authenticated snyk site, not part of the per-instance authorized application.

@agatakrajewska agatakrajewska force-pushed the fix/IGNR-245-fix-broken-license-issue-url branch 7 times, most recently from a809421 to 4fd0901 Compare September 3, 2024 12:33
@agatakrajewska agatakrajewska force-pushed the fix/IGNR-245-fix-broken-license-issue-url branch from 4fd0901 to 6685a34 Compare September 3, 2024 16:03
@agatakrajewska agatakrajewska merged commit ba7eaa8 into main Sep 3, 2024
11 checks passed
@agatakrajewska agatakrajewska deleted the fix/IGNR-245-fix-broken-license-issue-url branch September 3, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants