Skip to content

Commit 755485b

Browse files
authored
Use GitHub Flavored Markdown alerts for some notes (#51)
1 parent 77b72c9 commit 755485b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Welcome to the Renovate hands-on tutorial.
77
This tutorial is based on the Mend Renovate App.
88
You can also run Renovate as a CLI tool or a self-hosted application.
99

10-
> **Note**
10+
> [!NOTE]
1111
> Although this tutorial is based on the Mend Renovate App, the concepts discussed apply to all environments.
1212
1313
In this tutorial, you will learn how to configure Renovate and become familiar with some of the basic features.
@@ -68,8 +68,8 @@ Now you have installed the Mend Renovate App, we can begin onboarding.
6868

6969
Let’s review the concepts of the Onboarding PR and learn about Renovate’s initial settings.
7070

71-
> **Note**
72-
> For your convenience, Renovate will not make any changes to your repo or raise PRs until after you finish onboarding.
71+
> [!NOTE]
72+
> Renovate waits for you to finish onboarding, before making changes to your repo or raises PRs.
7373
7474
- Upon installing Renovate, an onboarding PR will be automatically generated.
7575
- This PR is there to help you understand Renovate and its default settings before Renovate starts running on your repository.
@@ -91,8 +91,8 @@ Let’s review the onboarding PR:
9191
- The link to Renovate’s official [documentation](https://docs.renovatebot.com/).
9292
- The link to review jobs logs in the [Renovate dashboard](https://app.renovatebot.com/dashboard).
9393

94-
> **Note**
95-
> Renovate will not create dependency update PRs until the onboarding PR will be merged.
94+
> [!NOTE]
95+
> Renovate only creates dependency update PRs _after_ you merge the onboarding PR.
9696
9797
#### These are some of the default configurations of Renovate:
9898

@@ -133,7 +133,7 @@ Let’s try changing this hourly limitation to 3:
133133

134134
<img width="830" alt="onboarding warning hourly update" src="https://user-images.githubusercontent.com/102745725/178960884-40077a5c-8fe1-422f-81c1-567ea1e6619b.png">
135135

136-
> **Note**
136+
> [!NOTE]
137137
> May take a few moments to update.
138138
139139
6. Merge the onboarding pull request.
@@ -144,8 +144,8 @@ Let’s try changing this hourly limitation to 3:
144144

145145
Now that you have merged the onboarding PR, Renovate will generate Update PRs to the most recent dependency version based on your configuration.
146146

147-
> **Note**
148-
> PRs may take a couple of minutes to appear
147+
> [!NOTE]
148+
> PRs may take a couple of minutes to appear.
149149
150150
Here we will review the basic concepts of Renovate update PRs and merge it.
151151

@@ -174,7 +174,7 @@ Let’s go ahead and take a look at a Renovate update PR:
174174

175175
1. Merge this pull request
176176

177-
> **Note**
177+
> [!NOTE]
178178
> Renovate is highly configurable and supports:
179179
>
180180
> - On-demand PR creation.
@@ -203,7 +203,7 @@ Since GitHub defaults to disable `issues` on forked repositories, we need to ena
203203

204204
- In order for the Dependency Dashboard to become available, we will need to re-run Renovate by triggering a webhook (for example, closing an update PR).
205205

206-
> **Note**
206+
> [!NOTE]
207207
> This is usually done in a click via the Dependency Dashboard.
208208
209209
1. Go to the `Pull requests` section
@@ -213,7 +213,7 @@ Since GitHub defaults to disable `issues` on forked repositories, we need to ena
213213

214214
3. This will trigger Renovate to run and the Dependency Dashboard will appear under the `Issues` section - navigate to it
215215

216-
> **Note**
216+
> [!NOTE]
217217
> It may take a minute to appear.
218218
219219
### The Dependency Dashboard includes:
@@ -243,7 +243,7 @@ Renovate offers an option to prevent automatic creation of major version update
243243

244244
In the Dependency Dashboard, under the `Rate Limited` section, the `Update dependency commander to vX` is waiting to be created.
245245

246-
> **Note**
246+
> [!NOTE]
247247
> Based on the previously set `prHourlyLimit` configuration, 3 PRs per hour in our case, this PR will be created within an hour.
248248
249249
<img width="928" alt="commander in Rate Limited" src="https://user-images.githubusercontent.com/102745725/178960104-c254c12f-08fb-4508-824d-20df60b2290f.png">
@@ -266,7 +266,7 @@ In order to limit all `major` updates to on-demand creation:
266266

267267
2. Commit the changes
268268

269-
> **Note**
269+
> [!NOTE]
270270
> Changing the `renovate.json` configuration file is a webhook that triggers Renovate to re-run.
271271
272272
3. Now go back to the Dependency Dashboard in the Issues section

0 commit comments

Comments
 (0)