Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drevops/renovate-drupal
Renovate configuration for automated Drupal dependency updates
https://github.com/drevops/renovate-drupal
circleci drupal github-actions renovate
Last synced: 3 months ago
JSON representation
Renovate configuration for automated Drupal dependency updates
- Host: GitHub
- URL: https://github.com/drevops/renovate-drupal
- Owner: drevops
- License: gpl-3.0
- Created: 2022-05-16T01:14:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T20:16:59.000Z (3 months ago)
- Last Synced: 2024-11-03T21:19:44.469Z (3 months ago)
- Topics: circleci, drupal, github-actions, renovate
- Homepage:
- Size: 118 KB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Renovate configuration for automated Drupal dependency updates.
[](https://dl.circleci.com/status-badge/redirect/gh/drevops/renovate-circleci-drupal-example/tree/main)
## Features
1. Dual schedules for package updates:
- Daily update schedule for critical Drupal core and related packages created in the `deps/minor-patch-core` branch.
- Weekly update schedule for all other packages created in the `deps/minor-patch-contrib` branch.
2. Automatically adds a `dependencies` label to a pull request.
3. Automatically adds assignees to a pull request.
4. Optional configuration for running Renovate self-hosted instance using GitHub Actions.
5. Optional configuration for running Renovate self-hosted instance using CircleCI.
## Installation
Renovate can run as hosted GitHub app or as a standalone self-hosted service in your CI provider (GitHub or CircleCI).
A self-hosted service can be beneficial when your project is restricted in terms of third-party access.
### Hosted GitHub app
1. Copy `renovate.json` to your repository.
2. Follow steps in [the official Renovate docs](https://docs.renovatebot.com/getting-started/installing-onboarding/).
### Self-hosted on GitHub actions
1. Copy `renovate.json` to your repository.
2. Copy `.github/workflows/renovate.yml` to your repository.
3. Create GitHub read/write access token and add it as a value for `RENOVATE_TOKEN` environment variable in GitHub Secrets.
### Self-hosted on CircleCI
1. Copy `renovate.json` to your repository.
2. Copy jobs from `.circleci/config.yml` to your CI config.
a. Update `RENOVATE_REPOSITORIES` with the name of your repository.
b. Update cron schedule to run as often as you like (once or twise a day).
3. Create GitHub read/write access token and add it as a value for `RENOVATE_TOKEN` environment variable in CircleCI UI. This is used to submit PRs and update Renovate dashboard issues.
4. Create GitHub read-only access token and add it as a value for `GITHUB_COM_TOKEN` environment variable in CircleCI UI. This is used to overcome GitHub API rate limit when Renovate downloads information aboout your packages.
Read more about environment variables [Renovate Authentication](https://docs.renovatebot.com/examples/self-hosting/#circleci).
## Testing
Provided `composer.json` and `composer.lock` are used to test Renovates configuration.
Note that in addition to Drupal and Composer packages, we are using 3 custom (empty) packages with specific versions:
- https://github.com/drevops/renovate-example-source1
- https://github.com/drevops/renovate-example-source2
- https://github.com/drevops/renovate-example-source3
**Expected minor and patch updates for core**
```
- drupal/core-composer-scaffold (9.2.0 -> 9.3.13)
- drupal/core-project-message (9.3.12 -> 9.3.13)
- drupal/core-recommended (9.3.12 -> 9.3.13)
```
**Expected minor and patch updates for contribs**
```
- drevops/renovate-example-source (1.0.0 => 1.0.4)
- drevops/renovate-example-source2 (1.0.0 => 1.2.0)
- drupal/coffee (1.0.0 => 1.2.0)
- drupal/core-dev (9.3.12 -> 9.3.13)
- drupal/core-composer-scaffold (9.2.0 => 9.3.12)
- vlucas/phpdotenv (v5.0.0 => v5.4.1)
- drupal/core-composer-scaffold (9.2.0 => 9.3.12)
- drevops/renovate-example-source (1.0.0 => 1.0.4)
- drevops/renovate-example-source2 (1.0.0 => 1.2.0)
- drupal/coffee (1.0.0 => 1.2.0)
- vlucas/phpdotenv (v5.0.0 => v5.4.1)
```
**Should not update**
```
- drush/drush (10.* => 11.*) - Drush updates are excluded
- drevops/renovate-example-source3 (1.* => 3.*) - Major versions are updated manually
```
## About platform version constraints
RenovateBot assesses 3 places to determine the PHP platform requirements:
1. The `require.php` version value in `composer.json`.
2. The `config.platform` version value in `composer.json`.
3. The `constraints.php` version value in `renovate.json`.
The purpose of `require.php` is to set the minimum PHP language requirements
for a package. For example, the minimum version required for Drupal 10 is 8.0.2
or above, which can be specified as `>=8`.
The purpose of `config.platform` is to set the PHP language requirements for the
specific instance of the package running in the current environment. For
example, while the minimum version required for Drupal 10 is 8.0.2 or above, the
actual PHP version on the hosting provider could be `8.1.0`. The value of this
field should provide your exact version of PHP with all 3 parts of the version.
The purpose of `constraints.php` is to set the PHP language requirements for the
RenovateBot run, in case the above two values are not set or need to be
overridden.
### Which versions to specify in a Drupal site?
It is recommended to specify `require.php` as a _range_ constraint (e.g. `>=8.1`)
to ensure it is used as the minimum requirement for project dependencies.
It is also recommended to specify `config.platform` as a _specific version_ (e.g.
`8.1.19`) constraint to ensure that only the package versions supported by your
current environment are used.
Once the PHP version of your environment is updated, the `config.platform`
value should also be updated to the specific version.
It is not recommended to use `constraints.php` in `renovate.json`, as every
project may use a different version of PHP. This value should only be used if
your Drupal project does not have `require.php` or `config.platform` provided
(in which case those values should be provided instead).