Skip to content
Snippets Groups Projects
Unverified Commit bb45bc37 authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

docs: prevent line ending problems when self-hosting on Windows (#16326)

parent 7adab3cc
No related branches found
No related tags found
No related merge requests found
......@@ -173,5 +173,12 @@ Use [Named Capturing Groups](https://www.regular-expressions.info/named.html) wh
### Windows
We recommend you set [`core.autocrlf = input`](https://git-scm.com/docs/gitattributes#_text) in your `gitConfig`, or the carriage return `\r\n` might confuse Renovate bot.
We recommend you set [`core.autocrlf = input`](https://git-scm.com/docs/gitattributes#_text) in your Git config.
You can do this by running this Git command:
```bash
git config --global core.autocrlf input
```
This prevents the carriage return `\r\n` which may confuse Renovate bot.
You can also set the line endings in your repository by adding `* text=auto eol=lf` to your `.gitattributes` file.
......@@ -39,6 +39,18 @@ Once you're done selecting repositories for Renovate to run on, click the green
Unfortunately Mend's hosted GitLab app needed to be taken offline indefinitely until a viable security model for bots on GitLab.com is available.
For more details on GitLab security for bots, please see the [GitLab Bot Security](../gitlab-bot-security.md) doc.
### Self-hosting on Windows
We recommend you set [`core.autocrlf = input`](https://git-scm.com/docs/gitattributes#_text) in your Git config.
You can do this by running this Git command:
```bash
git config --global core.autocrlf input
```
This prevents the carriage return `\r\n` which may confuse Renovate bot.
You can also set the line endings in your repository by adding `* text=auto eol=lf` to your `.gitattributes` file.
## Repository onboarding
Once you have enabled Renovate on a repository, you will get a "Configure Renovate" Pull Request looking something like this:
......
......@@ -16,6 +16,8 @@ Self-hosting Renovate means that you are the "administrator" of the bot, which e
- You ensure it's running regularly,
- You ensure Renovate bot itself is updated
Read our section on [Self-hosting on Windows](./installing-onboarding.md#self-hosting-on-windows) to prevent line endings from confusing Renovate bot.
### Available distributions
#### npm package (CLI)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment