Skip to content

docs(upgrading): add generate-clients doc dependencies #2224

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

Merged
merged 2 commits into from
Apr 17, 2021

Conversation

PaulThompson
Copy link
Contributor

Documentation to mention dependency on smithy-typescript.

Issue #1291

Description

Add link in documentation text for the dependency smithy-typescript

Testing

The link to external dependency install steps works, as has been noted by myself and @ajredniwja

Additional context

The dependency on smithy-typescript crosses over from the usual node/javascript package ecosystem into java/maven/gradle used by smithy. It's also for an internal/developer step in the codebase. As such it is not an automated install of the dependency.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@PaulThompson PaulThompson force-pushed the feat-doc-smithy-typescript branch from d3e716e to 55f87a3 Compare April 8, 2021 23:29
@ajredniwja ajredniwja changed the title Update generate-clients doc dependencies docs(upgrading): add generate-clients doc dependencies Apr 8, 2021
Copy link
Contributor

@ajredniwja ajredniwja left a comment

Choose a reason for hiding this comment

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

Just a small change: Can "It requires" be changed to follow "Follow steps found at: url" as it is already under prerequisites section.

I also changed the title to follow the semantic pull request rules.

Copy link
Contributor

@AllanZhengYP AllanZhengYP left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! The requires in no needed as it's already under Prerequisite sectioin.

@codecov-commenter
Copy link

codecov-commenter commented Apr 17, 2021

Codecov Report

Merging #2224 (55f87a3) into main (6b4bde6) will increase coverage by 31.53%.
The diff coverage is n/a.

❗ Current head 55f87a3 differs from pull request most recent head 3efee45. Consider uploading reports for the commit 3efee45 to get more accurate results
Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2224       +/-   ##
===========================================
+ Coverage   47.92%   79.45%   +31.53%     
===========================================
  Files         535      366      -169     
  Lines       33253    15324    -17929     
  Branches     8241     3310     -4931     
===========================================
- Hits        15937    12176     -3761     
+ Misses      17316     3148    -14168     
Impacted Files Coverage Δ
.../client-s3/commands/PutBucketReplicationCommand.ts
...ts/client-lex-runtime-service/LexRuntimeService.ts
...ents/client-s3/commands/GetObjectTorrentCommand.ts
...eteBucketIntelligentTieringConfigurationCommand.ts
...nt-lex-runtime-service/commands/PostTextCommand.ts
.../commands/DeleteStorageLensConfigurationCommand.ts
...ents/client-s3/commands/PutBucketTaggingCommand.ts
...ient-s3/commands/PutBucketRequestPaymentCommand.ts
clients/client-s3/S3Client.ts
...ents/client-s3/commands/PutBucketWebsiteCommand.ts
... and 159 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b4bde6...3efee45. Read the comment docs.

@AllanZhengYP AllanZhengYP merged commit 56dae4e into aws:main Apr 17, 2021
@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

  • CodeBuild project: sdk-staging-test
  • Commit ID: 3efee45
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@github-actions
Copy link

github-actions bot commented May 2, 2021

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants