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.

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: add documentation for the Developer Portal host rules credentials #32542

Merged
merged 7 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/usage/getting-started/private-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -611,7 +611,7 @@ If you need to provide credentials to the Mend Renovate App, please do this:
}
```

For more details, see [Using Secrets with Mend Cloud Apps](../mend-hosted/app-secrets.md).
For more details, see [Using Secrets with Mend Cloud Apps](../mend-hosted/credentials.md).

### Access to GitHub Actions Secrets

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/mend-hosted/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: Mend-hosted Apps
nav:
- 'Configuration': 'hosted-apps-config.md'
- 'App Secrets': 'app-secrets.md'
- 'Credentials': 'credentials.md'
- 'Migrating Secrets': 'migrating-secrets.md'
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ To add a secret for the Mend cloud app:
![Credentials settings page](../assets/images/app-settings/app-credentials.png)

4. Reference the secret from Renovate config files inside the repo.
Alternatively, you can use the Host Rules UI (see below).

```json
{
Expand All @@ -43,6 +44,21 @@ To add a secret for the Mend cloud app:
}
```

### Adding a host rule through the UI
rarkins marked this conversation as resolved.
Show resolved Hide resolved

You can centrally add/configure Host Rules through the Mend UI as an alternative to including them in Renovate presets.

1. Open the _Credentials_ section of the settings page for the relevant Org or Repo.
2. Select `ADD HOST RULE` to open the "Add a Host Rule" dialog box.

![Add Host Rule](../assets/images/app-settings/add-host-rule.png)

3. Fill out the details for your host rule.

As an example, if you are a Bitbucket or Azure DevOps user, and you want to specify a github.com token to fetch release notes and enable github-based datasources, you could create a host rule like this:

![Host Rules dialog box](../assets/images/app-settings/host-rules.png)

## Organization secrets vs repository secrets

### Secret scope
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/mend-hosted/migrating-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ If you were expecting to import a secret originally encrypted by Renovate:

## Related links

- [Using Secrets with Mend Cloud Apps](app-secrets.md)
- [Using Secrets with Mend Cloud Apps](credentials.md)