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

Supporting a minimum TS version #11319

Closed
33 tasks
deyaaeldeen opened this issue Sep 17, 2020 · 1 comment
Closed
33 tasks

Supporting a minimum TS version #11319

deyaaeldeen opened this issue Sep 17, 2020 · 1 comment
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.

Comments

@deyaaeldeen
Copy link
Member

deyaaeldeen commented Sep 17, 2020

This epic is to track adding support for a minimum TS version of 3.5.

  • merge [TypeScript] Drop support for TS 3.1 azure-sdk#1805.
  • close [Track2] Add downlevel types to all track2 packages #8275.
  • there are some packages that contain type declarations for 3.1 and some do not.
    • for packages that do not contain the type declarations for 3.1, do the following:
      1. add downlevel-dts as a dev dependency.
      2. update api-extractor.json so that the dtsRollup.publicTrimmedFilePath points to the new location for the current types, e.g. "./types/core-auth.d.ts" -> "./types/latest/core-auth.d.ts".
      3. add the following build:types script to package.json "build:types": "downlevel-dts types/latest types/3.5" and update the build script to run it as the last step.
      4. update package.json types field to point to the new location from step 2, e.g. "types": "./types/core-auth.d.ts" -> "types": "./types/latest/core-auth.d.ts".
      5. add a typesVersions field to package.json. This is used to map type declarations based on the version of TypeScript the user is using. Example from core-auth:
        "typesVersions": {
          "<=3.5": {
            "types/latest/*": [
              "types/3.5/*"
            ]
          }
        }
      6. update package.json's files entry to include types/latest/ and types/3.5/.
      • List of those packages:
        • Text Analytics
        • App Configuration
        • Key Vault
        • Search
        • Identity
        • Schema Registery
        • Event Grid
        • Tables
        • Core
          • abort-controller
          • arm
          • asynciterator-polyfill
          • lro
          • paging
          • tracing
          • logger
    • for packages that do contain the type declarations for 3.1,
      1. update the version of downlevel-dts to the most recent.
      2. update api-extractor.json config so that the dtsRollup.publicTrimmedFilePath points to the new location for the current types, e.g. "./types/core-auth.d.ts" -> "./types/latest/core-auth.d.ts".
      3. update the build:types script in package.json to be "build:types": "downlevel-dts types/latest types/3.5".
      4. update the typesVersions field in package.json to have 3.5 instead of 3.1.
      5. update package.json's files entry to include types/3.5/ instead of types/3.1/.
      • List of those packages:
        • Service Bus
        • Event Hubs
        • Storage
          • blob
          • file-datalake
          • file-share
          • queue
        • Core
          • ampq
          • auth
          • auth
  • update all docs to not mention TS 3.1 (e.g. https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/textanalytics/ai-text-analytics/README.md#document-error-handling does)
  • add a CI step to parse the types declaration file in types/<package name>.d.ts using TS 3.5.
  • remove the step of testing against TS 3.1 from our release checklist.
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Sep 17, 2020
@deyaaeldeen deyaaeldeen self-assigned this Sep 17, 2020
@deyaaeldeen deyaaeldeen added this to the Backlog milestone Sep 17, 2020
@deyaaeldeen deyaaeldeen added the Client This issue points to a problem in the data-plane of the library. label Sep 17, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Sep 17, 2020
@xirzec xirzec modified the milestones: Backlog, MQ-2020 Sep 17, 2020
@Azure Azure deleted a comment Sep 28, 2020
@ramya-rao-a ramya-rao-a modified the milestones: MQ-2020, Backlog Dec 17, 2020
@jeremymeng jeremymeng added Epic EngSys This issue is impacting the engineering system. and removed Epic labels Sep 17, 2021
@jeremymeng jeremymeng changed the title [Epic] Supporting a minimum TS version Supporting a minimum TS version Sep 22, 2021
@deyaaeldeen
Copy link
Member Author

Closing this in favor of #19843

@xirzec xirzec removed this from the Backlog milestone May 17, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.
Projects
None yet
Development

No branches or pull requests

4 participants