Skip to content

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Jan 31, 2024

Description of your changes

Formalize our versioning policy with a dedicated page similar to the AWS SDK, adjusted to Powertools for AWS Lambda (TypeScript) and our community.

Related issues, RFCs

Issue number: #1995

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Signed-off-by: heitorlessa <[email protected]>
@heitorlessa heitorlessa requested a review from a team January 31, 2024 09:48
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jan 31, 2024
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jan 31, 2024
@heitorlessa
Copy link
Contributor Author

@dreamorosi @am29d ready for review.

Two recommendations after merging tho:

  1. Add a documentation banner to emphasize the v2 RFC
  2. Update the RFC with the target date for v2

@dreamorosi dreamorosi linked an issue Jan 31, 2024 that may be closed by this pull request
2 tasks
@dreamorosi dreamorosi changed the title docs(process): add versioning and maintenance policy docs(maintenance): add versioning and maintenance policy Jan 31, 2024
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Hi @heitorlessa thank you so much for taking the time to open a PR.

Content looks good and in line with what agreed internally, so we're good on that side.

I've left 2 comments, one of them about a change.

Looking forward to merge this after they're addressed!

Copy link

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

2 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@dreamorosi dreamorosi self-requested a review January 31, 2024 10:30
Copy link
Contributor

@dreamorosi dreamorosi 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 this PR, as I said in the other one this will be very useful!

@dreamorosi dreamorosi merged commit 49c5f48 into aws-powertools:main Jan 31, 2024
@heitorlessa heitorlessa deleted the docs/versioning-policy branch January 31, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Versioning policy
2 participants