Skip to content

chore: rename project to Powertools for AWS Lambda (TypeScript) #1472

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 15 commits into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ body:
- type: input
id: version
attributes:
label: AWS Lambda Powertools for TypeScript version
label: Powertools for AWS Lambda (TypeScript) version
placeholder: "latest, 1.3.0"
value: latest
validations:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest an idea to the Lambda Powertools project.
Thank you for taking the time to suggest an idea to the Powertools for AWS Lambda (TypeScript) project.
- type: textarea
id: problem
attributes:
Expand Down Expand Up @@ -34,9 +34,9 @@ body:
attributes:
label: Acknowledgment
options:
- label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets)
- label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets)
required: true
- label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/)
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/)
required: false
- type: markdown
attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ body:
attributes:
label: Acknowledgment
options:
- label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets)
- label: This request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets)
required: true
- label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/)
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/)
required: false
- type: markdown
attributes:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
- type: dropdown
id: area
attributes:
label: Which AWS Lambda Powertools utility does this relate to?
label: Which Powertools for AWS Lambda (TypeScript) utility does this relate to?
options:
- Tracer
- Logger
Expand Down Expand Up @@ -81,9 +81,9 @@ body:
attributes:
label: Acknowledgment
options:
- label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets)
- label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets)
required: true
- label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/)
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/)
required: false
- type: markdown
attributes:
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/share_your_work.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: I Made This (showcase your work)
description: Share what you did with Powertools 💞💞. Blog post, workshops, presentation, sample apps, etc.
description: Share what you did with Powertools for AWS Lambda (TypeScript) 💞💞. Blog post, workshops, presentation, sample apps, etc.
title: "[I Made This]: <TITLE>"
labels: ["community-content"]
body:
Expand All @@ -13,7 +13,7 @@ body:
description: |
Please share the original link to your material.

*Note: Short links will be expanded when added to Powertools documentation*
*Note: Short links will be expanded when added to Powertools for AWS Lambda (TypeScript) documentation*
validations:
required: true
- type: textarea
Expand Down Expand Up @@ -44,13 +44,13 @@ body:
description: |
Any notes you might want to share with us related to this material.

*Note: These notes are explicitly to Powertools maintainers. It will not be added to the community resources page.*
*Note: These notes are explicitly to Powertools for AWS Lambda (TypeScript) maintainers. It will not be added to the community resources page.*
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: I understand this content may be removed from Powertools documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct)
- label: I understand this content may be removed from Powertools for AWS Lambda (TypeScript) documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct)
required: true
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/support_powertools.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: Support Lambda Powertools (become a reference)
description: Add your organization's name or logo to the Lambda Powertools documentation
title: "[Support Lambda Powertools]: <your organization name>"
name: Support Powertools for AWS Lambda (TypeScript) (become a reference)
description: Add your organization's name or logo to the Powertools for AWS Lambda (TypeScript) documentation
title: "[Support Powertools for AWS Lambda (TypeScript)]: <your organization name>"
labels: ["customer-reference"]
body:
- type: markdown
attributes:
value: |
Thank you for becoming a reference customer. Your support means a lot to us. It also helps new customers to know who're using Lambda Powertools.
Thank you for becoming a reference customer. Your support means a lot to us. It also helps new customers to know who're using Powertools for AWS Lambda (TypeScript).

If you would like us to also display your organization's logo, please share a link in the `Company logo` field.
- type: input
Expand Down Expand Up @@ -42,13 +42,13 @@ body:
id: use_case
attributes:
label: (Optional) Use case
description: How are you using Lambda Powertools today? *features, etc.*
description: How are you using Powertools for AWS Lambda (TypeScript) today? *features, etc.*
validations:
required: false
- type: checkboxes
id: other_languages
attributes:
label: Also using other Lambda Powertools languages?
label: Also using other Powertools for AWS Lambda languages?
options:
- label: Python
required: false
Expand All @@ -59,6 +59,6 @@ body:
- type: markdown
attributes:
value: |
*By raising a Support Lambda Powertools issue, you are granting AWS permission to use your company's name (and/or logo) for the limited purpose described here. You are also confirming that you have authority to grant such permission.*
*By raising a Support Powertools for AWS Lambda (TypeScript) issue, you are granting AWS permission to use your company's name (and/or logo) for the limited purpose described here. You are also confirming that you have authority to grant such permission.*

*You can opt-out at any time by commenting or reopening this issue.*
4 changes: 2 additions & 2 deletions .github/boring-cyborg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ labelPRBasedOnFilePath:
firstPRWelcomeComment: >
Thanks a lot for your first contribution! Please check out our [contributing guidelines](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/chore/pr_automation/CONTRIBUTING.md) and don't hesitate to ask whatever you need.

In the meantime, check out the #typescript channel on our AWS Lambda Powertools Discord: [Invite link](https://discord.gg/B8zZKbbyET)
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)

# Comment to be posted to congratulate user on their first merged PR
firstPRMergeComment: >
Expand All @@ -170,4 +170,4 @@ firstPRMergeComment: >
firstIssueWelcomeComment: >
Thanks for opening your first issue here! We'll come back to you as soon as we can.

In the meantime, check out the #typescript channel on our AWS Lambda Powertools Discord: [Invite link](https://discord.gg/B8zZKbbyET)
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET)
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ reported the issue. Please try to include as much information as you can. Detail

## Getting Started

The following steps describe how to set up the AWS Lambda Powertools for TypeScript repository on your local machine.
The following steps describe how to set up the Powertools for AWS Lambda (TypeScript) repository on your local machine.

The alternative is to use a Cloud IDE like [Gitpod](https://www.gitpod.io/) or [GitHub CodeSpaces](https://github.com/features/codespaces) for your development. To quickly get up and running you can click one of these button to open a cloned version of this repo with all of the prerequisites and dependencies installed:

Expand Down Expand Up @@ -98,11 +98,11 @@ the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeu

### Repo Layout

The AWS Lambda Powertools is a npm project written in [TypeScript](https://www.typescriptlang.org/).
The Powertools for AWS Lambda (TypeScript) is a npm project written in [TypeScript](https://www.typescriptlang.org/).
More specifically, it is a [monorepo managed using npm workspaces](https://docs.npmjs.com/cli/v8/using-npm/workspaces).
If you're unfamiliar with any of these technologies, it is useful to learn about them and will make understanding the codebase easier but strictly not necessary for simple contributions.

The repo contains `packages/` directory that contains the Powertools utilities modules. For instance, the source code for the Logger utility can be found at the location `packages/logger` and so on.
The repo contains `packages/` directory that contains the Powertools for AWS Lambda (TypeScript) utilities modules. For instance, the source code for the Logger utility can be found at the location `packages/logger` and so on.
The repo also contains a `packages/commons` directory that holds code and logic shared between one or more utilities and that is published as a separate npm package.

### Tests
Expand Down Expand Up @@ -205,7 +205,7 @@ You can run the end-to-end tests automatically on your forked project by followi

### Examples

As part of the repo you will find an examples folder at the root. This folder contains examples (written with CDK and SAM) of deployable AWS Lambda functions using Powertools.
As part of the repo you will find an examples folder at the root. This folder contains examples (written with CDK and SAM) of deployable AWS Lambda functions using Powertools for AWS Lambda (TypeScript).

To test your updates with these examples, you just have to:

Expand Down Expand Up @@ -314,7 +314,7 @@ Work your magic. Before starting, make sure to check the [Getting Started](#Gett

* Create a commit with your changes and push them to a
[fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
> Note: Core members can push directly to a branch on the AWS Lambda Powertools (TypeScript) repo (following the same conventions detailed below).
> Note: Core members can push directly to a branch on the Powertools for AWS Lambda (TypeScript) repo (following the same conventions detailed below).
* Create a [pull request on GitHub](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).

* Pull request title and message (and PR title and description) must adhere to
Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ To run locally, you need [AWS CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/

### Releasing a documentation hotfix

You can rebuild the latest documentation without a full release via this [GitHub Actions Workflow](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/workflows/publish-docs-on-release.yml). Choose `Run workflow`, keep `main` as the branch, and input the latest Powertools version available i.e. `v1.4.1`.
You can rebuild the latest documentation without a full release via this [GitHub Actions Workflow](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/workflows/publish-docs-on-release.yml). Choose `Run workflow`, keep `main` as the branch, and input the latest Powertools for AWS Lambda (TypeScript) version available i.e. `v1.4.1`.

This workflow will update both user guide and API documentation.

Expand Down
Loading