zT-1337
ddc46220b9
* - Added Renovate support for the [SCM-Manager](https://scm-manager.org/) - SCM-Manager is a repository management tool like GitHub - It is maintained as an open source project by the company [Cloudogu](https://cloudogu.com/en/) - The SCM-Manager support is not feature complete yet, features like auto merging are still missing - The SCM-Manager also got added to the documentation as another platform author Thomas Zerr <thomas.zerr@cloudogu.com> 1690877165 +0200 committer Eduard Heimbuch <eduard.heimbuch@cloudogu.com> 1706264263 +0100 * Reverted numbering change in markdown docs * Changed from type to interface, if possible * Removed axios dependency and using the http layer of renovate instead * Fixed not using scmm specific mime types for accept header * Use git from test/util instead * Add dummy tests for no ops * Fix some phrasing and spelling issues * Change scmm to scm-manager and fix SCM-Manager specific content type * Add supported major versions, review plugin requirement, write permissions is needed * Change using actual host rules instead of mocking it * Change use http mocks for testing * Update docs/usage/getting-started/running.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update lib/modules/platform/scm-manager/index.ts Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update lib/modules/platform/scm-manager/mapper.spec.ts Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update lib/modules/platform/scm-manager/readme.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update lib/modules/platform/scm-manager/readme.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update lib/modules/platform/scm-manager/readme.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update lib/modules/platform/scm-manager/readme.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update lib/modules/platform/scm-manager/readme.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Fix scm-manager docs link * Fix linting * Fix linting * Throw errors if username or token is not provided by the host rules * Replace NO-OP with Not implemented * Remove objects from log messages * Fix linting * Fix path to platform config options * Fix link to self-host-configuration docs * Fix link to self-host-configuration docs * Remove the link to the platform config option, because the tests keep failing * Fix link to self-host-configuration docs * Remove not needed type cast Co-authored-by: Michael Kriese <michael.kriese@visualon.de> * Fix type check of protocol links * Move scm-manager into util http folder * Apply linting * Add maxBodyLength function and its test * Add test case if protocol links are not an array of links * Use zod schema for pagination * Apply linting * Refactor typing with zod schema * Fix test description Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Fix test description Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Fix test description Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Fix test description Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update readme Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Add try catch around fetching the current user * Switch log statement from info to debug Co-authored-by: Michael Kriese <michael.kriese@visualon.de> * Switch log statement from info to trace Co-authored-by: Michael Kriese <michael.kriese@visualon.de> * Switch log statement from debug to trace Co-authored-by: Michael Kriese <michael.kriese@visualon.de> * Switch log statement from info to trace Co-authored-by: Michael Kriese <michael.kriese@visualon.de> * Switch log statement from info to trace Co-authored-by: Michael Kriese <michael.kriese@visualon.de> * Switch log statement from info to trace Co-authored-by: Michael Kriese <michael.kriese@visualon.de> * Fix linting errors * Remove credentials check in initRepo * Fix imports * Fix zod schema for repositories * Fix zod schema for pull requests * Fix 500 error after attempting to update an pr * Fix wrong typing * Refactor parameterized tests for better readability * Refactor SCM HTTP API * Add setToken functionality * Remove not needed type definition Co-authored-by: Michael Kriese <michael.kriese@gmx.de> * Fix assertion * Fix istanbul comment * Change log statement * Remove type rename * Move inferred types close to corresponding schemas * Add platform is experimental * Remove type renaming * Fix type imports * Fix test suite description * Remove debug log statement Co-authored-by: Michael Kriese <michael.kriese@gmx.de> * Fix warning * Fix paremeterized unit tests with string templates * Fix spelling Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Fix eslint error * Convert trace logs to debug logs * Convert info logs to debug * Replace manual null and undefinded check with is util * Rephrase instruction in readme * Use ensureTrailingSlash instead * Fix linting * Keep type and schema together * Simplify hasAssignees check * Simplify reviewer mapping * Remove istanbul comments * Replace custom scmm header option with renovate native http headers option * Let the token be passed in initPlatform * Add description which permissions are needed * Add support for ignorePrAuthor filter * Add notes about automerge feature within platform readme * Add support for fast_forward_only * Change supported versions due to merge strategy change * Remove commented code * Fix import * Use email schema * Heed review advice * Fix import and empty array assertions * Fix linting issue * Fix import errors * Fix removed ignorePrAuthor parameter from initRepo function * Fix failing unit tests by setting/reseting the global config * Mark scm-manager as experimental * Fix zod import path * Change endpoint configuration, so that user only needs to define origin, but not also the path * Fix warning of redundant backslash --------- Co-authored-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com> Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Co-authored-by: Michael Kriese <michael.kriese@visualon.de> Co-authored-by: René Pfeuffer <rene@pfeuffer-web.de> Co-authored-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: René Pfeuffer <rene.pfeuffer@cloudogu.com>
6.9 KiB
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
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, then e-mail us at: renovate-disclosure@mend.io. 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.
Please do not create GitHub issues for security-related doubts or problems.