Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

Commit

Permalink
Merge pull request #255 from skabashnyuk/STONEBLD-2373
Browse files Browse the repository at this point in the history
Explain how to configure Renovate for GitLab
  • Loading branch information
gtrivedi88 authored May 6, 2024
2 parents c144bc3 + 9b54522 commit fe7b4f7
Showing 1 changed file with 7 additions and 45 deletions.
52 changes: 7 additions & 45 deletions docs/modules/ROOT/pages/concepts/RenovateBot/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,50 +4,12 @@ RenovateBot is a service that detects dependencies in your build pipeline and th

RenovateBot monitors Tekton bundle references and makes sure that they're up to date. When new versions of the Tekton bundles are available, RenovateBot creates a pull request with the updated references. This gives you time to review, change, and incorporate the new bundles.

== Configuration

Configure RenovateBot through its `renovate.json` configuration file. The following is a sample `renovate.json` file:

Sample:

----
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"timezone": "America/New_York",
"schedule": ["before 10pm"],
"tekton": {
"fileMatch": ["\\.yaml$", "\\.yml$"],<1>
"pinDigests": true <2>
}
}
----

Notice the following Tekton items in `renovate.json`:

<1> `link:https://docs.renovatebot.com/configuration-options/#filematch[fileMatch]`: An array type. RenovateBot parses each string in `fileMatch`, then extracts matching file names from a repository. In this sample, `fileMatch` directs RenovateBot to extract all `.yaml` and `.yml` files in your repository.

<2> `link:https://docs.renovatebot.com/configuration-options/#pindigests[pinDigests]`: A boolean type. When enabled, RenovateBot pins any Docker images or GitHub actions by means of their `SHA256` digest so that they're immutable.

You can also update `renovate.json` with link:https://docs.renovatebot.com/configuration-options/#[many other options].

== Additional information

See an example in the xref:how-to-guides/configuring_renovatebot.adoc[Configuring RenovateBot] guide.
== Authentication and authorization
To create pull requests in the target source code repositories Renovate bot must have appropriate credentials.

* **GitHub Application** - Requires `Red Hat Konflux` GitHub App to be installed in the source code repository.

* **GiLab application**. Create a link:https://docs.renovatebot.com/modules/platform/gitlab/#authentication[Personal Access Token] (PAT) for the Renovate bot account. Add PAT using link:https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/configuring-builds/proc_creating-secrets-for-your-builds/[
Creating secrets for your builds]. The secret must have the following labels:
- `appstudio.redhat.com/credentials: scm`
- `appstudio.redhat.com/scm.host: <your_domain_name>` - For example, appstudio.redhat.com/scm.host: gitlab.myhost.com

0 comments on commit fe7b4f7

Please sign in to comment.