8000 fix(repo): unify aws-cdk dep across repo by lucasdellabella · Pull Request #3798 · metriport/metriport · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(repo): unify aws-cdk dep across repo #3798

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

lucasdellabella
Copy link
Contributor
@lucasdellabella lucasdellabella commented May 7, 2025

metriport/metriport-internal#1040

Ref: ENG-263
Signed-off-by: Lucas Della Bella dellabella.lucas@gmail.com

Dependencies

None

Description

packages/infra/package.json uses "~2.133.0" as its dependency.

Let's install aws-cdk at the mono repo level to create a clear default version for cli use. This also means we really should be using a consistent version in our gh actions workflows.

Testing

None

Release Plan

  • Merge this

Summary by CodeRabbit

  • Chores
    • Upgraded AWS CDK version to 2. 8000 133.0 in all deployment workflows.
    • Added "aws-cdk" (version ~2.133.0) to development dependencies.
    • Minor reordering of dependencies in the package configuration.

metriport/metriport-internal#1040

Ref: ENG-263
Signed-off-by: Lucas Della Bella <dellabella.lucas@gmail.com>
Copy link
linear bot commented May 7, 2025

Copy link
coderabbitai bot commented May 7, 2025

Walkthrough

The changes update the AWS CDK version from 2.122.0 to 2.133.0 in all relevant GitHub Actions workflow files and add the corresponding "aws-cdk" package as a development dependency in package.json. No other logic, control flow, or error handling modifications were made.

Changes

File(s) Change Summary
.github/workflows/_deploy-cdk.yml
.github/workflows/_deploy-hl7-notification-cdk.yml
.github/workflows/_deploy-hl7-vpn-tunnel-cdk.yml
Updated AWS CDK version from 2.122.0 to 2.133.0 in all deployment steps using the CDK GitHub Action.
package.json Added "aws-cdk" with version "~2.133.0" to devDependencies; reordered "sharp" and "semver" in dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions Workflow
    participant AWS CDK
    participant AWS Cloud

    GitHub Actions Workflow->>AWS CDK: Install CDK v2.133.0
    GitHub Actions Workflow->>AWS CDK: Run cdk diff/deploy steps
    AWS CDK->>AWS Cloud: Deploy/Update Cloud resources
    AWS Cloud-->>AWS CDK: Deployment status
    AWS CDK-->>GitHub Actions Workflow: Report results
Loading

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@lucasdellabella lucasdellabella marked this pull request as ready for review May 7, 2025 19:10
Copy link
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
package.json (1)

70-71: Review dependency ordering change
The swap of "semver" and "sharp" ordering in dependencies seems incidental. Consider using a consistent ordering strategy (e.g., alphabetical) to reduce churn and improve readability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9546a22 and 9eeca63.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • .github/workflows/_deploy-cdk.yml (8 hunks)
  • .github/workflows/_deploy-hl7-notification-cdk.yml (4 hunks)
  • .github/workflows/_deploy-hl7-vpn-tunnel-cdk.yml (1 hunks)
  • package.json (3 hunks)
🔇 Additional comments (14)
package.json (1)

80-81: Add aws-cdk to devDependencies
Adding "aws-cdk": "~2.133.0" here aligns your monorepo CLI version with the workflows. Please verify that your lock file (package-lock.json or yarn.lock) is updated to reflect this new devDependency.

.github/workflows/_deploy-hl7-vpn-tunnel-cdk.yml (1)

105-106: Bump CDK version for VPN Tunnel Stack
Updated the cdk_version input to "2.133.0" to match the standardized AWS CDK version across the repo.

.github/workflows/_deploy-cdk.yml (8)

202-203: Bump CDK version for Secrets diff
The cdk_version input for the Secrets stack diff step is updated to "2.133.0".


214-215: Bump CDK version for Secrets deploy
The cdk_version input for the Secrets stack deploy step is updated to "2.133.0".


230-231: Bump CDK version for Location Services diff
The cdk_version input for the Location Services stack diff step is updated to "2.133.0".


244-245: Bump CDK version for Location Services deploy
The cdk_version input for the Location Services stack deploy step is updated to "2.133.0".


259-260: Bump CDK version for API diff
The cdk_version input for the API stack diff step is updated to "2.133.0".


271-272: Bump CDK version for API deploy
The cdk_version input for the API stack deploy step is updated to "2.133.0".


287-288: Bump CDK version for IHE diff
The cdk_version input for the IHE stack diff step is updated to "2.133.0".


300-301: Bump CDK version for IHE deploy
The cdk_version input for the IHE stack deploy step is updated to "2.133.0".

.github/workflows/_deploy-hl7-notification-cdk.yml (4)

132-133: Bump CDK version for Secrets diff
The cdk_version input for the Secrets stack diff step is updated to "2.133.0".


144-145: Bump CDK version for Secrets deploy
The cdk_version input for the Secrets stack deploy step is updated to "2.133.0".


159-160: Bump CDK version for HL7 Notification diff
The cdk_version input for the HL7 Notification Routing stack diff step is updated to "2.133.0".


172-173: Bump CDK version for HL7 Notification deploy
The cdk_version input for the HL7 Notification Routing stack deploy step is updated to "2.133.0".

@@ -77,6 +77,7 @@
"@tsconfig/recommended": "^1.0.2",
"@typescript-eslint/eslint-plugin": "^5.48.2",
&q 8000 uot;@typescript-eslint/parser": "^5.48.2",
"aws-cdk": "~2.133.0",
Copy link
Member

Choose a reason for hiding this comment

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

since this can be executed outside of our npm scripts, I suggest doing a global install, like we have on preinstall - link

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@leite08 but instead of doing a global install we can just have people run this via npx cdk ... which imo is better, esp since it ties the version of cdk to the standard npm install flow.

Copy link
Member

Choose a reason for hiding this comment

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

Great point, let's keep like this and move the ones on preinstall here, update the README/onboarding and notify the team?

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 think the ones in preinstall need to stay there because is-ci is used in prepare-dev which runs on preinstall, before dependencies get installed. And rimraf is used to nuke node_modules which would include nuking itself if it wasn't installed globally.

At least thats what it looks like to me

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.

2 participants
0