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

feat: provide easy way to update snyk-ls in CLI [IDE-144] #5067

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

bastiandoetsch
Copy link
Contributor

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.

What does this PR do?

This commit just refactors the existent script that covered only go-application-framework, to now support any dependency in the snyk github organization.

It does that by introducing a new optional --name parameter that should contain the github repository name.

If not called with this parameter, it will update go-application-framework and snyk-ls.

It should be considered, whether this should be made part of the pipeline or not, e.g.

  • execute script
  • commit new go.mod/go.sum
  • build CLI
  • run acceptance tests

Where should the reviewer start?

At the changed file

How should this be manually tested?

Execute the python script (ensure to have python3)

Any background context you want to provide?

As we bundle Snyk-LS into the CLI, it is important to always bundle the latest version. This scripts facilitates the change. A followup will or may be that the LS pipeline automatically creates a PR for any merge to LS main branch.

What are the relevant tickets?

IDE-144

Screenshots

Additional questions

This commit just refactors the existent script that covered only go-application-framework, to now support any dependency in the snyk github organization.

It does that by introducing a new optional `--name` parameter that should contain the github repository name.

If not called with this parameter, it will update go-application-framework and snyk-ls.

It should be considered, whether this should be made part of the pipeline or not, e.g.

- execute script
- commit new go.mod/go.sum
- build CLI
- run acceptance tests
@bastiandoetsch bastiandoetsch requested a review from a team as a code owner February 23, 2024 08:13
@bastiandoetsch bastiandoetsch merged commit e9723af into main Feb 23, 2024
14 checks passed
@bastiandoetsch bastiandoetsch deleted the feat/IDE-144_automate-dependency-upgrade-of-LS branch February 23, 2024 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants