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

Maintenance: group typedoc and its plugin together in Dependabot #2715

Closed
1 of 2 tasks
dreamorosi opened this issue Jul 1, 2024 · 2 comments · Fixed by #2716
Closed
1 of 2 tasks

Maintenance: group typedoc and its plugin together in Dependabot #2715

dreamorosi opened this issue Jul 1, 2024 · 2 comments · Fixed by #2716
Assignees
Labels
automation This item relates to automation 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.)

Comments

@dreamorosi
Copy link
Contributor

Summary

Whenever a new "major"* TypeScritpt version is released, typedoc the module we use to render API docs needs to be upgraded to support it. The same is true for any of the typedoc-* plugins, which usually target a specific Typedoc version.

We should add a new dependency group to the Dependabot configuration so that they're all upgraded together.

  • TS doesn't follow semver, instead minor versions are to be considered akin to major ones.

Why is this needed?

Because otherwise the PRs are created individually, which causes noise and the Dependabot PR to fill until all the relevant modules are ready to be upgraded. This way we will get a single PR for all the packages and avoid this:

image

Which area does this relate to?

Automation

Solution

No response

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

@dreamorosi dreamorosi added automation This item relates to automation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) confirmed The scope is clear, ready for implementation labels Jul 1, 2024
@dreamorosi dreamorosi self-assigned this Jul 1, 2024
@dreamorosi dreamorosi moved this from Triage to Working on it in Powertools for AWS Lambda (TypeScript) Jul 1, 2024
@dreamorosi dreamorosi moved this from Working on it to Pending review in Powertools for AWS Lambda (TypeScript) Jul 1, 2024
@github-project-automation github-project-automation bot moved this from Pending review to Coming soon in Powertools for AWS Lambda (TypeScript) Jul 1, 2024
Copy link
Contributor

github-actions bot commented Jul 1, 2024

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments 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.

@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 Jul 1, 2024
Copy link
Contributor

This is now released under v2.4.0 version!

@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 Jul 11, 2024
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation 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.)
Projects
Development

Successfully merging a pull request may close this issue.

1 participant