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(cli): show warning when toolkit is using a deprecated version #32406

Closed
wants to merge 5 commits into from

Conversation

stm29
Copy link
Contributor

@stm29 stm29 commented Dec 6, 2024

Issue # (if applicable)

Closes #298

Reason for this change

  • When a toolkit's version is deprecated, it will not be displayed till now unless user manually checks it.
  • This Change gives warning when Deprecated version is being used

Description of changes

  • Created simple interface IsVersionMarkedDeprecated which gives us, the toolkit's version is deprecated with a reason.

Description of how you validated changes

Moved to the following directory, after pulling the actual repo

aws-cdk/packages/aws-cdk

Changed package.json file with following version, 2.167.0 is marked as deprecated in - https://www.npmjs.com/package/aws-cdk/v/2.167.0

  "name": "aws-cdk",
  "description": "CDK Toolkit, the command line tool for CDK apps",
  "version": "2.167.0",
  "bin": {
    "cdk": "bin/cdk"
  },

And run the following command, and verfied the changes

stmohan@bcd0743dbc73:aws-cdk$ DEBUG_MODE=true && rm -rf ~/.cdk/ && /Users/stmohan/Desktop/AWS_CDK/aws-cdk/packages/aws-cdk/bin/cdk init --list
Available templates:
* app: Template for a CDK Application
   └─ cdk init app --language=[csharp|fsharp|go|java|javascript|python|typescript]
* lib: Template for a CDK Construct Library
   └─ cdk init lib --language=typescript
* sample-app: Example CDK Application with some constructs
   └─ cdk init sample-app --language=[csharp|fsharp|go|java|javascript|python|typescript]
***********************************************************************************************************************
*** You are using DEPRECATED version : [2.167.0], reason : Some authentication scenarios are broken in this version ***
*** Newer version of CDK is available [2.171.1]                                                                     ***
*** Upgrade recommended (npm install -g aws-cdk)                                                                    ***
***********************************************************************************************************************
stmohan@bcd0743dbc73:aws-cdk$ 

(memo): unit tests reference for mocking child_process.exec wrapped with promosify - stackoverflow : here

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@stm29 stm29 requested a review from a team as a code owner December 6, 2024 19:35
@github-actions github-actions bot added the repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK label Dec 6, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team December 6, 2024 19:35
@github-actions github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1 labels Dec 6, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Dec 6, 2024
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.72%. Comparing base (06cdaac) to head (6f2415c).
Report is 139 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32406      +/-   ##
==========================================
+ Coverage   78.66%   78.72%   +0.06%     
==========================================
  Files         107      107              
  Lines        7237     7254      +17     
  Branches     1329     1332       +3     
==========================================
+ Hits         5693     5711      +18     
+ Misses       1358     1357       -1     
  Partials      186      186              
Flag Coverage Δ
suite.unit 78.72% <100.00%> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 78.72% <100.00%> (+0.06%) ⬆️

@mrgrain mrgrain changed the title feat(toolkit): show warning when toolkit is using a deprecated version feat(cli): show warning when toolkit is using a deprecated version Dec 7, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 6f2415c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation
Copy link
Collaborator

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

@aws-cdk-automation
Copy link
Collaborator

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

@aws-cdk-automation aws-cdk-automation added the closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. label Jan 4, 2025
Copy link

github-actions bot commented Jan 4, 2025

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 4, 2025
@aws-cdk-automation
Copy link
Collaborator

The pull request linter fails with the following errors:

❌ Features must contain a change to an integration test file and the resulting snapshot.
❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32406/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1 pr/needs-cli-test-run This PR needs CLI tests run against it. repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Toolkit: warn/error in case toolkit is using a deprecated version
2 participants