-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from agaroot-technologies/chore/readme
[chore] Update README.md
- Loading branch information
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,55 @@ | ||
# renovate-config | ||
|
||
[![license](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/agaroot-technologies/renovate-config/blob/main/LICENSE) | ||
[![Github](https://img.shields.io/github/followers/agaroot-technologies?label=Follow&logo=github&style=social)](https://github.com/orgs/agaroot-technologies/followers) | ||
|
||
This is a Renovate config commonly inherited by Agaroot products. | ||
|
||
Use this setting to keep up with updates to the library and maintain high code quality. | ||
|
||
## 👏 Getting Started | ||
|
||
### 1. Install Renovate App | ||
|
||
Install the [Renovate App](https://github.com/apps/renovate) in the repository. | ||
|
||
### 2. Allow auto merge | ||
|
||
Allow [automatic merging](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request) of repositories to make Renovate auto-merge work. | ||
|
||
Updates below the minor version will be merged automatically, so be sure to use [branch protection rules](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) accordingly. | ||
|
||
### 3. Install Auto Approve Bot | ||
|
||
Install the [Approve App](https://github.com/apps/renovate-approve) that automatically approves pull requests in the repository. | ||
|
||
If merging a pull request requires the approval of two people, install an additional [Approve2 App](https://github.com/apps/renovate-approve-2) in the repository. | ||
|
||
### 4. Configure Renovate | ||
|
||
Create a Renovate configuration file (`renovate.json`), and add `github>agaroot-technologies/renovate-config` to the extends property. | ||
|
||
```json | ||
{ | ||
"$schema": "https://docs.renovatebot.com/renovate-schema.json", | ||
"extends": [ | ||
"github>agaroot-technologies/renovate-config" | ||
] | ||
} | ||
``` | ||
|
||
If additional settings are required, modify the configuration accordingly. | ||
|
||
Check the [Renovate documentation](https://docs.renovatebot.com/configuration-options/) for configuration details. | ||
|
||
## 🤝 Contributing | ||
|
||
Contributions, issues and feature requests are welcome. | ||
|
||
Feel free to check [issues page](https://github.com/agaroot-technologies/renovate-config/issues) if you want to contribute. | ||
|
||
## 📝 License | ||
|
||
Copyright © 2020 [AGAROOT TECHNOLOGIES](https://tech.agaroot.co.jp/). | ||
|
||
This project is [```MIT```](https://github.com/agaroot-technologies/renovate-config/blob/main/LICENSE) licensed. |