Skip to content

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

Closed
@dreamorosi

Description

@dreamorosi

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.

Metadata

Metadata

Assignees

Labels

automationThis item relates to automationcompletedThis item is complete and has been merged/shippedinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Type

No type

Projects

Status

Shipped

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions