mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-25 23:11:31 +00:00
Jamie Tanna
2d239d2cc1
* 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>
18 lines
591 B
TypeScript
18 lines
591 B
TypeScript
import type { Category } from '../../../constants/index.ts';
|
|
import { GitlabTagsDatasource } from '../../datasource/gitlab-tags/index.ts';
|
|
import { extractPackageFile } from './extract.ts';
|
|
|
|
export { extractPackageFile };
|
|
|
|
export const displayName = 'GitLab CI/CD include';
|
|
export const url = 'https://docs.gitlab.com/ee/ci/yaml/includes.html';
|
|
export const categories: Category[] = ['ci'];
|
|
|
|
export const defaultConfig = {
|
|
managerFilePatterns: ['/\\.gitlab-ci\\.ya?ml$/'],
|
|
};
|
|
|
|
export const supportedDatasources = [GitlabTagsDatasource.id];
|
|
|
|
export { knownDepTypes } from './dep-types.ts';
|