Skip to content

Maintenance: add README to Parameters utility published on npm #1492

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 of 2 tasks
dreamorosi opened this issue Jun 9, 2023 · 2 comments · Fixed by #1504
Closed
1 of 2 tasks

Maintenance: add README to Parameters utility published on npm #1492

dreamorosi opened this issue Jun 9, 2023 · 2 comments · Fixed by #1504
Assignees
@dreamorosi
Labels
completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) parameters This item relates to the Parameters Utility
Milestone
Parameters - GA R...

Comments

@dreamorosi
Copy link
Contributor

Summary

When we publish a utility to npmjs.com, the README file of the utility is used as cover page for people visiting the page of the package. Currently the page is empty and this is likely due to the README file not being included in the tarball published to npm.

Why is this needed?

We need to fix this so that users landing on the page for the first time will know what the utility is about and maybe try it.

Which area does this relate to?

Parameters

Solution

No response

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.
@dreamorosi dreamorosi added triage This item has not been triaged by a maintainer, please wait internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Jun 9, 2023
@dreamorosi dreamorosi added parameters This item relates to the Parameters Utility and removed triage This item has not been triaged by a maintainer, please wait labels Jun 9, 2023
@dreamorosi dreamorosi added this to the Parameters - GA Release milestone Jun 9, 2023
@dreamorosi dreamorosi added the confirmed The scope is clear, ready for implementation label Jun 9, 2023
@dreamorosi dreamorosi self-assigned this Jun 9, 2023
@dreamorosi dreamorosi moved this from Backlog to Working on it in AWS Lambda Powertools for TypeScript Jun 12, 2023
@dreamorosi dreamorosi mentioned this issue Jun 15, 2023
Merged
9 tasks
@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Jun 16, 2023
@dreamorosi dreamorosi linked a pull request Jun 16, 2023 that will close this issue
chore(maintenance): cleaned up package.json files #1504
Merged
9 tasks
@dreamorosi dreamorosi moved this from Working on it to Coming soon in AWS Lambda Powertools for TypeScript Jun 16, 2023
@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped pending-release This item has been merged and will be released soon and removed pending-release This item has been merged and will be released soon completed This item is complete and has been merged/shipped labels Jun 16, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 23, 2023 •
edited by dreamorosi
Loading

This is now released under version 1.10.0!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Jun 23, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dreamorosi dreamorosi

Labels
completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) parameters This item relates to the Parameters Utility
Projects
Powertools for AWS Lambda (TypeScript)
Status: Shipped
Milestone
Parameters - GA Release
Development

Successfully merging a pull request may close this issue.

chore(maintenance): cleaned up package.json files aws-powertools/powertools-lambda-typescript
1 participant
@dreamorosi