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

chore: add new interfaces for Assets #12700

Merged
merged 5 commits into from
Jan 31, 2021

Commits on Jan 25, 2021

  1. chore: add new interfaces for Assets

    In V2, we want to get rid of the @aws-cdk/assets module,
    as it's considered deprecated in V1.
    Unfortunately, the module contains an interface,
    CopyOptions, that is used, through interface inheritance,
    in the public API of many stable CDK modules like ECS, Lambda, ECR, CodeBuild, etc.
    
    While we have a CopyOptions interface in @aws-cdk/core,
    it unfortunately shares the same name, `follow`,
    with the property in the "old" CopyOptions.
    But the two different `follow` properties have different types.
    For that reason, if we're going to remove the "old" CopyOptions using JSII's "strip deprecated" option,
    we can't use the "new" CopyOptions in the inheritance hierarchy alongside the "old" CopyOptions,
    as the two definitions of `follow` would conflict.
    
    For that reason, create a new FileCopyOptions interface which renames the `follow` property to `followSymlinks`.
    Also add a FileFingerprintOptions interface that does a similar trick to the FingerprintOptions interface
    (which extends CopyOptions), which is used in the public API of modules that use Docker assets.
    
    Also extract a few module-private interfaces to avoid duplication of properties between all of these interfaces.
    skinny85 committed Jan 25, 2021
    Configuration menu
    Copy the full SHA
    8b4c9b6 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    eaf0f9f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    d4710fc View commit details
    Browse the repository at this point in the history

Commits on Jan 28, 2021

  1. Obtains -> Options in CopyOptions JSDocs

    Co-authored-by: Elad Ben-Israel <benisrae@amazon.com>
    skinny85 and Elad Ben-Israel authored Jan 28, 2021
    Configuration menu
    Copy the full SHA
    11b7c13 View commit details
    Browse the repository at this point in the history

Commits on Jan 31, 2021

  1. Configuration menu
    Copy the full SHA
    35fef7e View commit details
    Browse the repository at this point in the history