secustor
3890ecf3b5
Finding P10. Optional `Platform` members were guarded ad hoc at ~12 call
sites in three styles: optional call (`platform.labelCharLimit?.() ?? 50`),
explicit guard (the identical `if (platform.refreshPr)` block three times)
and ternary fallback (`platform.filterUnavailableUsers ? ... : ...`).
The type is now split. `PlatformModule` is what a platform module exports
and what `api.ts` registers; `Platform` is that module type with the
defaulted members made required, and is what the exported `platform` Proxy
hands to consumers. `setPlatformApi` composes
`{ ...platformDefaults, ...platformModule }` — spreading an ES module
namespace copies its own enumerable exports and keeps function identity,
so `platform.x` stays referentially stable.
Members made required, with their default:
- getIssue -> null
- getVulnerabilityAlerts -> []
- getBranchForceRebase -> false
- refreshPr -> no-op
- expandGroupMembers -> identity
- filterUnavailableUsers -> identity
- labelCharLimit -> 50
- extractRulesFromCodeOwnersLines -> the plain CODEOWNERS parser that
used to live in `workers/repository/update/pr/code-owners.ts`
Members left optional, because consumers read their absence as a
capability flag rather than as "do nothing":
- tryReuseAutoclosedPr — `pr-reuse.ts` skips the `findPr` call entirely
- reattemptPlatformAutomerge — `branch/index.ts` skips the dry-run log line
- isBranchMergeQueueEnabled / isPrInMergeQueue — a platform either has a
merge queue, in which case `mergePr` enqueues instead of merging, or it
has neither member
- addLabel, commitFiles — no consumer reaches them through `platform`
- experimental — a marker, not a method
`syncForkWithUpstream` is on `PlatformScm`, not `Platform`, so it is out
of scope here.
Behaviour changes:
- `init/index.ts` warns about unsupported `filterUnavailableUsers` /
`expandCodeOwnersGroups` through the new `platformSupports()` helper,
which compares the selected platform's member against the shared
default. The warnings are unchanged.
- `config-migration/branch/index.ts` now calls `getBranchPr` on every
platform rather than only on those implementing `refreshPr`; the extra
lookup happens only when a config-migration PR was just rebased.
- `onboarding/branch/index.ts` and `update/branch/index.ts` drop an
`istanbul ignore if` and a `v8 ignore else`; both `refreshPr` calls are
now covered.
What is the Mend Renovate CLI?
Renovate is an automated dependency update tool. It helps to update dependencies in your code without needing to do it manually. When Renovate runs on your repo, it looks for references to dependencies (both public and private) and, if there are newer versions available, Renovate can create pull requests to update your versions automatically.
Features
- Delivers update PRs directly to your repo
- Relevant package files are discovered automatically
- Pull Requests automatically generated in your repo
- Provides useful information to help you decide which updates to accept (age, adoption, pass rates, merge confidence)
- Highly configurable and flexible to fit in with your needs and repository standards
- Largest collection of languages and platforms (listed below)
- Connects with private repositories and package registries
Languages
Renovate can provide updates for most popular languages, platforms, and registries including: npm, Java, Python, .NET, Scala, Ruby, Go, Docker and more. Supports over 90 different package managers.
Platforms
Renovate updates code repositories on the following platforms: GitHub, GitLab, Bitbucket, Azure DevOps, AWS Code Commit (experimental), Gitea, Forgejo, Gerrit (experimental), SCM-Manager (experimental)
Ways to run Renovate
The most effective way to run Renovate is to use an automated job scheduling system that regularly runs Renovate on all enabled repositories and responds with priority to user activity. Mend offers cloud-hosted and self-hosted solutions. See the options below.
Mend Renovate Community (Cloud-Hosted)
Supports: GitHub.com, Bitbucket Cloud
Hosted by Mend.io. No setup is needed. Community plan available (Free)
- GitHub Cloud: Install the Renovate Cloud-Hosted App on your GitHub org, then select the repos to enable
- Bitbucket Cloud: Add the Mend App to your Workspace, then add the Mend Renovate user to the projects you want to enable
Mend Renovate Community (Self-hosted)
Supports: GitHub, GitLab, Bitbucket Data Center
Install and run your own Renovate server. Access internal packages.
- Mend Renovate Community Self-Hosted (Free)
- Mend Renovate Enterprise (Paid plan)
Other ways to run Renovate
If you can’t use a pre-built job scheduling system, or want to build your own, the following options are available:
Run Renovate on your Pipeline
Mend provides a GitHub Action or a GitLab Runner to help you run Renovate as a CI pipeline job.
- GitHub Action: renovatebot/github-action.
- GitLab Runner: Renovate Runner project
- AzureDevOps action: Renovate Me extension
Note: This extension is created and maintained personally by a Renovate developer/user. Support requests for the extension will not be answered directly in the main Renovate repository. - Custom pipeline: You can create a custom pipeline with a yml definition that triggers npx renovate. More details on how to configure the pipeline.
Run Renovate CLI
There are several ways to run the Renovate CLI directly. See docs: Running Renovate for all options.
Supports: all platforms
For additional community-maintained options, see the Community Tools page.
Docs
More about Renovate
- Renovate basics
- Supported platforms and languages
- Advanced Renovate usage
Renovate Docs
Comparisons
Get involved
Issues and Discussions
Please open a Discussion to get help, suggest a new feature, or to report a bug. We only want maintainers to open Issues.
Contributing
To contribute to Renovate, or run a local copy, please read the contributing guidelines.
- Guidelines for Contributing
- Items that need contribution: good first issues
Contact and Social Media
The Renovate project is proudly supported and actively maintained by Mend.io.
- Contact Mend.io for commercial support questions.
Follow us on:
- Twitter: x.com/mend_io
- LinkedIn: linkedin.com/company/mend-io
Security / Disclosure
If you find any bug with Renovate that may be a security problem, please report it through the GitHub Security Advisories process. This way we can evaluate the bug and hopefully fix it before it gets abused. Please give us enough time to investigate the bug before you report it anywhere else.
If you would like to discuss a potential finding before raising the Advisory, then e-mail us at: renovate-disclosure@mend.io.