Skip to content

Commit

Permalink
Merge branch 'main' into docs/rewrite-running-renovate
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose committed May 18, 2023
2 parents 6a714d3 + fc5ddaa commit bb49dba
Show file tree
Hide file tree
Showing 169 changed files with 7,043 additions and 4,740 deletions.
3 changes: 2 additions & 1 deletion .devcontainer/devcontainer.json
Expand Up @@ -19,7 +19,8 @@
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"orta.vscode-jest",
"EditorConfig.editorconfig"
"editorconfig.editorconfig",
"github.vscode-github-actions"
]
}
},
Expand Down
28 changes: 24 additions & 4 deletions .github/label-actions.yml
Expand Up @@ -23,12 +23,12 @@
The Renovate team
'logs:problem':
'needs-logs':
comment: >
Hi there,
We found a problem with the logs.
This issue or discussion is missing some logs, making it difficult or impossible to help you.
Depending on which situation applies follow one, some or all of these instructions.
Expand Down Expand Up @@ -178,6 +178,26 @@
The Renovate team
'pr:discussion-first':
comment: >
**Please create a GitHub Discussion before continuing with this PR.**
Thank you for your PR, but we need to discuss the requirements and implementation first.
This PR will be closed, but you can reopen it after the discussion has been resolved.
Thanks, The Renovate team
close: true

'needs-details':
comment: >
Hi there,
This discussion is missing some details, making it difficult or impossible to help you.
Please try again to provide more details.
'needs-discussion':
unlabel:
- 'type:bug'
Expand All @@ -199,9 +219,9 @@
lock: true
lock-reason: 'resolved'

'needs-code-formatting':
'format-code-comments':
comment: >
Hi, please format your code or logs so they're readable.
Hi, please format any copy/pasted code or logs so they're readable.
You can find a Markdown code formatting guide [here](https://www.markdownguide.org/basic-syntax/#code) as well as some GitHub-specific information formatting code blocks [here](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Expand Up @@ -97,7 +97,7 @@ jobs:
run: yarn jest --ci --coverage ${{ env.coverage }}

- name: Codecov
uses: codecov/codecov-action@894ff025c7b54547a9a2a1e9f228beae737ad3c2 # v3.1.3
uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
if: always() && env.coverage == 'true'

- name: E2E Test
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/label-actions.yml
Expand Up @@ -5,11 +5,14 @@ on:
types: [labeled]
discussion:
types: [labeled]
pull_request_target:
types: [labeled]

permissions:
contents: read
issues: write
discussions: write
pull-requests: write

jobs:
reaction:
Expand All @@ -18,4 +21,3 @@ jobs:
- uses: dessant/label-actions@074b96a62f35c226ecb38e840f44941bde0343a6 # v3.0.0
with:
github-token: ${{ github.token }}
process-only: 'issues, discussions'
7 changes: 0 additions & 7 deletions .gitpod.yml

This file was deleted.

1 change: 0 additions & 1 deletion .husky/pre-commit
@@ -1,7 +1,6 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

yarn lint-staged
yarn ls-lint

BRANCH_NAME=$(git branch --show-current)
Expand Down
5 changes: 0 additions & 5 deletions .lintstagedrc.json

This file was deleted.

3 changes: 2 additions & 1 deletion .vscode/extensions.json
Expand Up @@ -3,6 +3,7 @@
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"orta.vscode-jest",
"EditorConfig.editorconfig"
"editorconfig.editorconfig",
"github.vscode-github-actions"
]
}
72 changes: 1 addition & 71 deletions docs/development/remote-development.md
Expand Up @@ -29,77 +29,7 @@ You'll use the same code editor and have the same config as all other developers

- Waiting for the remote container to start
- If your internet is down you can't work
- If Gitpod or Codespaces is down you can't work

## Gitpod

You can use [Gitpod](https://gitpod.io/) for light development work like:

- Editing the docs
- Running ESLint, Prettier

For proper development, use GitHub Codespaces.

The config file for Gitpod is `.gitpod.yml` in the root of the repository.

Gitpod gives you 500 free credits each month, which is enough for about 50 hours of work.

### Gitpod tips

- Use `yarn jest` to run the tests on Gitpod

### Known problems with Gitpod

There are two failing tests when running `yarn jest` on Gitpod:

```bash
Summary of all failing tests
FAIL lib/util/git/index.spec.ts (635.102 s, 319 MB heap size)
● util/git/index › isBranchModified() › should return false when author matches

expected true to be false or Boolean(false)

283 |
284 | it('should return false when author matches', async () => {
> 285 | expect(await git.isBranchModified('renovate/future_branch')).toBeFalse();
| ^
286 | expect(await git.isBranchModified('renovate/future_branch')).toBeFalse();
287 | });
288 |

at Object.<anonymous> (lib/util/git/index.spec.ts:285:68)

● util/git/index › isBranchModified() › should return false when author is ignored

expected true to be false or Boolean(false)

291 | gitIgnoredAuthors: ['custom@example.com'],
292 | });
> 293 | expect(await git.isBranchModified('renovate/custom_author')).toBeFalse();
| ^
294 | });
295 |
296 | it('should return true when custom author is unknown', async () => {

at Object.<anonymous> (lib/util/git/index.spec.ts:293:68)

FAIL test/static-files.spec.ts (14.506 s, 288 MB heap size)
● static-files › has same static files in lib and dist

thrown: "Exceeded timeout of 10000 ms for a test.
Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

36 | jest.setTimeout(10 * 1000);
37 |
> 38 | it('has same static files in lib and dist', async () => {
| ^
39 | expect(await getFiles('dist')).toEqual(await getFiles('lib'));
40 | });
41 | });

at test/static-files.spec.ts:38:3
at Object.<anonymous> (test/static-files.spec.ts:34:1)
```
- If Codespaces is down you can't work

## GitHub Codespaces

Expand Down
36 changes: 36 additions & 0 deletions docs/usage/configuration-options.md
Expand Up @@ -448,6 +448,11 @@ Check out the default value for `commitMessage` to understand how this field is
This is used to alter `commitMessage` and `prTitle` without needing to copy/paste the whole string.
The "extra" is usually an identifier of the new version, e.g. "to v1.3.2" or "to tag 9.2".

## commitMessageLowerCase

With `semanticCommits` pr- and commit-titles will by default (`"auto"`) be converted to all-lowercase.
Set this to `"never"` to leave the titles untouched, allowing uppercase characters in semantic commit titles.

## commitMessagePrefix

This is used to alter `commitMessage` and `prTitle` without needing to copy/paste the whole string.
Expand Down Expand Up @@ -698,6 +703,19 @@ You can configure this to `true` if you prefer Renovate to close an existing Dep
The labels only get updated when the Dependency Dashboard issue updates its content and/or title.
It is pointless to edit the labels, as Renovate bot restores the labels on each run.

## dependencyDashboardOSVVulnerabilitySummary

Use this option to control if the Dependency Dashboard lists the OSV-sourced CVEs for your repository.
You can choose from:

- `none` (default) do not list any CVEs
- `unresolved` list CVEs that have no fixes
- `all` list all CVEs

This feature is independent of the `osvVulnerabilityAlerts` option.

The source of these CVEs is [OSV.dev](https://osv.dev/).

## dependencyDashboardTitle

Configure this option if you prefer a different title for the Dependency Dashboard.
Expand Down Expand Up @@ -1190,6 +1208,23 @@ A preset alternative to the above is:
}
```

To match specific ports you have to add a protocol to `matchHost`:

```json
{
"hostRules": [
{
"matchHost": "https://domain.com:9118",
"enabled": false
}
]
}
```

<!-- prettier-ignore -->
!!! warning
Using `matchHost` without a protocol behaves the same as if you had set no `matchHost` configuration.

<!-- prettier-ignore -->
!!! note
Disabling a host is only 100% effective if added to self-hosted config.
Expand Down Expand Up @@ -3140,6 +3175,7 @@ This feature works with the following managers:
- [`kubernetes`](/modules/manager/kubernetes)
- [`ansible`](/modules/manager/ansible)
- [`droneci`](/modules/manager/droneci)
- [`terraform`](/modules/manager/terraform)

## registryUrls

Expand Down
6 changes: 3 additions & 3 deletions docs/usage/configuration-templates.md
Expand Up @@ -14,8 +14,8 @@ If you change the `branchPrefix` while you have ignored some upgrades (closed PR

`branchName` default value is `{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}`.

The most common branch name you will see looks like this: `renovate/react-17.x`.
In this example, the `branchPrefix` is the default `renovate/`, `additionalBranchPrefix` is empty, and `branchTopic` is `react-17.x`.
The most common branch name you will see looks like this: `renovate/react-18.x`.
In this example, the `branchPrefix` is the default `renovate/`, `additionalBranchPrefix` is empty, and `branchTopic` is `react-18.x`.

Most users will be happy with the default `branchPrefix` of `renovate/`, but you can change this if you don't like the default.
Say you don't want the forward slashes, in that case you would use `renovate-` as your `branchPrefix`.
Expand Down Expand Up @@ -47,7 +47,7 @@ You may want to edit this.
If you think your new `commitMessageTopic` is helpful for others, please [open a PR](https://github.com/renovatebot/renovate/pulls).

`commitMessageExtra` refers to the version being updated to.
e.g. `to v17` for a major upgrade, or `to v17.0.2` for a patch update.
e.g. `to v18` for a major upgrade, or `to v18.0.2` for a patch update.
It can be empty in some cases, like if the action/topic doesn't change a package version, e.g. `Pin Docker digests`.

`commitMessageSuffix` defaults to empty but is currently used in two cases:
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/docker.md
Expand Up @@ -388,7 +388,7 @@ To get access to the token a custom Renovate Docker image is needed that include
The Dockerfile to create such an image can look like this:

```Dockerfile
FROM renovate/renovate:35.73.0
FROM renovate/renovate:35.82.0
# Include the "Docker tip" which you can find here https://cloud.google.com/sdk/docs/install
# under "Installation" for "Debian/Ubuntu"
RUN ...
Expand Down

0 comments on commit bb49dba

Please sign in to comment.