Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(config options): rewrite ignoreScripts #32171

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
+24 −1
Draft

docs(config options): rewrite ignoreScripts #32171

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
707dbf4
docs(config options): update `ignoreScripts` section
HonkingGoose Oct 28, 2024
232a120
Update configuration-options.md
HonkingGoose Oct 28, 2024
0ab9e3f
Use h4 sub-heading to try to fix lint error
HonkingGoose Oct 28, 2024
5675488
Wrap failing h4 in ignore block for Markdown lint rule
HonkingGoose Oct 28, 2024
bacdc86
Apply suggestions from code review
HonkingGoose Oct 28, 2024
02be040
Small tweak to suggestion
HonkingGoose Oct 28, 2024
9f701e1
Merge branch 'main' into docs/30812-update-ignoreScripts-and-allowScr…
HonkingGoose Dec 4, 2024
6b157b2
Drop draft npm manager only script execution
HonkingGoose Dec 16, 2024
9b1dd57
Merge branch 'main' into docs/30812-update-ignoreScripts-and-allowScr…
HonkingGoose Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion docs/usage/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2109,7 +2109,32 @@ In the case that a user is automatically added as reviewer (such as Renovate App

## ignoreScripts

Applicable for npm, bun, Composer and Copier only for now. Set this to `true` if running scripts causes problems.
By default, Renovate will not run any scripts.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

<!-- markdownlint-disable MD001 -->

#### No script execution on free Mend-hosted Renovate

The Mend Renovate App does not allow scripts to run.
We do not plan to let users on free tiers run scripts, because the risk of abuse is too high.

#### Renovate Enterprise Cloud can be configured to run scripts

Scripts can be enabled for paying customers on Mend.io hosted apps.
Please ask Mend.io sales about "Renovate Enterprise Cloud".

#### Allowing scripts if self-hosting Renovate

If you are self-hosting Renovate, and want Renovate to run scripts:
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

1. Set the self-hosted config option [`allowScripts`](../self-hosted-configuration.md#allowscripts) to `true` in your bot/admin configuration
1. Set `ignoreScripts` to `false` for the package managers you want to allow to run scripts (only works for the listed supportedManagers in the table above)

##### Example config to allow scripts for npm

Insert example config that allows script execution for just the npm package manager.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you configure Renovate like this?

  1. Allow script execution, by setting the self-hosted config option allowScripts=true.
  2. But limit the risk, by only allowing the npm package manager to run scripts.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, allowScripts is a top-level global setting so is turned on for all managers or none

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dropped the section about the example config to allow scripts for just npm.


<!-- markdownlint-enable MD001 -->

## ignoreTests

Expand Down