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

ci(custom-checks): fix dependencies being inconsistent phase 5 #3688

Open
jagpreetsinghsasan opened this issue Dec 10, 2024 · 1 comment
Open
Labels
dependent enhancement New feature or request Keychain Tasks/bugs related to the Keychain plugin core interfaces or any of the implementations themselves.

Comments

@jagpreetsinghsasan
Copy link
Contributor

Description

As a developer, I want to fix the dependency versions being inconsistent across packages in Cacti.

Targeted packages:

packages/cactus-plugin-keychain-azure-kv
packages/cactus-plugin-keychain-google-sm
packages/cactus-plugin-keychain-memory
packages/cactus-plugin-keychain-memory-wasm
packages/cactus-plugin-keychain-vault

Depends on #3612

Solution:

Run the script tools/custom-checks/check-dependency-version-consistency.ts with fix: true, note down the changes for the above targeted packages, stash and drop the changes, and proceed with fixing just those targeted packages.

Possible errors

  1. The package being dependent on other packages can lead to conflicts in those dependent packages. Even if those newly failing package tests occur, fixing those in this phase becomes important or else we will have broken code in repo.
    To test this scenario, simply create a PR for this task fixing only the targeted packages and have a lookout on CI for any failing tests. If we have any failing tasks, we should fix them as a part of this task
  2. The fix might involve breaking changes, and shall be reported in the PR
  3. For some dependencies, the suggest change might not be an exact version (due to it being the highest version among all packages), so instead of including the versions like >=1.2.3, fix the root package which has this sort of version and then include that in the conflicting package (a 2 way solution)

Acceptance Criteria

  1. The above targeted packages have all the dependency version inconsistencies fixed
  2. No new crashes are seen in CI
@jagpreetsinghsasan jagpreetsinghsasan added enhancement New feature or request Keychain Tasks/bugs related to the Keychain plugin core interfaces or any of the implementations themselves. labels Dec 10, 2024
Copy link

This PR/issue depends on:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependent enhancement New feature or request Keychain Tasks/bugs related to the Keychain plugin core interfaces or any of the implementations themselves.
Projects
None yet
Development

No branches or pull requests

1 participant