Commit Graph

20 Commits

Author SHA1 Message Date
Jamie Tanna 2d239d2cc1 docs: explicitly document depTypes each manager supports (#42142)
* docs: explicitly document `depTypes` each manager supports

A long-standing question we receive is "what `depTypes` can I match
against in my project".

Although the best recommendation we usually have is "check the
`packageFiles with updates" log line (as a very key log line for users),
we can go one step further and try and create a stronger contract.

To do this, I've used Claude Sonnet 4.6 to work through the codebase,
determine areas that a `depType` is set in a manager (statically or
dynamically) and generate a structured, typed, means to document how
they're used.

Through a few iterations of the process, and attempts at human-written
documentation, we've settled on:

- prioritising autogenerated documentation (for humans to read) to note
  what `depTypes` are known, and what they are
- `knownDepTypes`, to describe any known, static, `depType`s and their
  human-readable meaning
  - with the `prettyDepType`, if used
- `supportsDynamicDepTypesNote`, to add a Markdown note to the generated
  documentation

While here, we also:

- make sure to note this in the "adding a new package manager"
  documentation
- remove any hand-written references to `depTypes` in each manager's
  documentation page
- correct the Gleam `depTypes`
- make sure to use the `knownDepTypes`'s `prettyDepType` definition if
  we know it, for a given `depType`

The descriptions have been generated by Claude Sonnet, with some
human-written tweaks where appropriate.

[0]: https://github.com/renovatebot/renovate/discussions/15176

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>

* fixup! docs: explicitly document `depTypes` each manager supports

* docs(manager): display `depTypes` documentation if none present

For consistency, and to make it more explicit.

---------

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>
2026-03-31 12:08:39 +00:00
Sebastian Poxhofer ec3952aaae docs(dev/adding-package-manager): reference lockfiles field (#37686) 2025-08-25 07:18:28 +00:00
HonkingGoose 98f2f75b7d docs(development): rewrite lock file implementation guide (#31328)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
2024-09-23 14:24:04 +00:00
Rhys Arkins 531d42dfe1 docs: add lock file implementation guide (#31243) 2024-09-09 06:39:25 +00:00
Tobias 5075318da1 test(manager): manager need to exports updateDependency or extractPackageFile when exporting extractAllPackageFiles (#27954)
Co-authored-by: Vivien Tintillier <vtintillier.privatedev@gmail.com>
2024-03-15 21:30:46 +00:00
Rhys Arkins 03c8ef7344 fix(lerna): don’t use packages if v7 or higher (#23756) 2023-08-08 14:29:32 +00:00
Sebastian Poxhofer 19259a0383 feat!: categories (#16534)
Closes #13953

Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

BREAKING CHANGE: languages are now called categories instead
2023-07-04 19:21:52 +02:00
HonkingGoose 9d4f56114f docs: replace comment with improved sentence (#22981) 2023-06-26 12:38:28 +00:00
HonkingGoose f12576ec26 docs: partial rewrite of developer docs (#22977) 2023-06-26 11:03:50 +00:00
Sebastian Poxhofer ab04c11f42 docs(adding-package-manager): add missing functions of ManagerAPI interface (#21535)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2023-04-29 08:40:17 +00:00
HonkingGoose 5a52b04c96 docs: replace contain(s) with has or have (#14692) 2022-03-16 14:50:20 +01:00
Rhys Arkins dca3418bbd refactor: lib/modules (#14488)
Moves datasource, manager, platform and versioning code from lib/ into new lib/modules/

BREAKING CHANGE: External tools must update paths to datasource, manager, platform and versioning
2022-03-04 09:04:02 +01:00
HonkingGoose a7903a4de2 docs: replace receive with get (#14073) 2022-02-07 15:53:22 +01:00
HonkingGoose 47703aabb6 docs: improve adding a package manager development (#7704) 2020-11-12 10:49:53 +01:00
HonkingGoose 32dd490672 docs: use one sentence per line (#7625) 2020-11-02 09:52:37 +01:00
HonkingGoose 89346338cb docs: fix capitalization/style errors (#7532)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2020-10-23 17:42:57 +02:00
Rhys Arkins 0b91457dc8 docs: update package manager doc 2020-08-05 22:14:06 +02:00
Rhys Arkins 485f66914e feat: versionScheme -> versioning (#5504) 2020-02-18 08:34:10 +01:00
Rhys Arkins 50e9a85961 docs: update development docs 2019-09-09 04:16:04 +02:00
Rhys Arkins af81448a87 docs: move to docs/development 2019-09-09 03:49:57 +02:00