diff --git a/.circleci/update-dependencies.yml b/.circleci/update-dependencies.yml index b0ab02379..fd1c54f69 100644 --- a/.circleci/update-dependencies.yml +++ b/.circleci/update-dependencies.yml @@ -30,7 +30,7 @@ jobs: # - RENOVATE_TOKEN: GitHub access token. # - RENOVATE_REPOSITORIES: Repository to run Renovate on as `vendor/repository`. # - RENOVATE_GIT_AUTHOR: Author for Renovate commits as `Name `. - # Variables provided below can be overridden in the CircleCI project settings. + # Optionally, set RENOVATE_DRY_RUN to `true` to run without making changes. update-dependencies: docker: - image: renovate/renovate:44.176.2 @@ -38,8 +38,6 @@ jobs: RENOVATE_PLATFORM: 'github' RENOVATE_AUTODISCOVER: false RENOVATE_DEPENDENCY_DASHBOARD_TITLE: 'Renovate Dependency Dashboard (self-hosted) by CircleCI' - RENOVATE_DEPENDENCY_DASHBOARD: false - RENOVATE_DRY_RUN: false LOG_LEVEL: 'debug' steps: diff --git a/.github/workflows/update-dependencies.yml b/.github/workflows/update-dependencies.yml index c13f82f89..f9c29f5bd 100644 --- a/.github/workflows/update-dependencies.yml +++ b/.github/workflows/update-dependencies.yml @@ -76,7 +76,6 @@ jobs: RENOVATE_AUTODISCOVER: false RENOVATE_REPOSITORIES: ${{ vars.RENOVATE_REPOSITORIES || github.repository }} RENOVATE_DEPENDENCY_DASHBOARD_TITLE: 'Renovate Dependency Dashboard (self-hosted) by GitHub Actions' - RENOVATE_DEPENDENCY_DASHBOARD: ${{ vars.RENOVATE_DEPENDENCY_DASHBOARD || 'false' }} RENOVATE_DRY_RUN: ${{ vars.RENOVATE_DRY_RUN || 'false' }} RENOVATE_GIT_AUTHOR: ${{ vars.RENOVATE_GIT_AUTHOR }} RENOVATE_FORCE: ${{ github.event_name == 'workflow_dispatch' && inputs.preserve_schedules == false && '{"schedule":[],"prHourlyLimit":0,"branchConcurrentLimit":0}' || '' }} diff --git a/.vortex/docs/.utils/variables/extra/ci.variables.sh b/.vortex/docs/.utils/variables/extra/ci.variables.sh index ee1e70dc8..1bfca0511 100755 --- a/.vortex/docs/.utils/variables/extra/ci.variables.sh +++ b/.vortex/docs/.utils/variables/extra/ci.variables.sh @@ -94,9 +94,6 @@ VORTEX_CI_ARTIFACTS=/tmp/artifacts # Create a GitHub token with a permission to write to a repository. RENOVATE_TOKEN= -# Whether to enable self-hosted Renovate bot dashboard. -RENOVATE_DEPENDENCY_DASHBOARD=false - # Whether to allow self-hosted Renovate bot make changes to the repository. RENOVATE_DRY_RUN=false diff --git a/.vortex/docs/content/development/dependency-updates.mdx b/.vortex/docs/content/development/dependency-updates.mdx index 4a4507081..8ebacdd27 100644 --- a/.vortex/docs/content/development/dependency-updates.mdx +++ b/.vortex/docs/content/development/dependency-updates.mdx @@ -160,9 +160,7 @@ The delay applies to routine updates only: a [security fix](#security-fixes) skips it. The Dependency Dashboard lists the updates waiting for the minimum age under -**Pending Status Checks**, where you can request an update early. The -self-hosted service turns the dashboard off by default: to see it, set -`RENOVATE_DEPENDENCY_DASHBOARD` to `true`. +**Pending Status Checks**, where you can request an update early. ### Security fixes @@ -312,8 +310,6 @@ a default: `yourorg/repo` (default: the current repository). - `RENOVATE_DRY_RUN`: Set to `true` to test runs without making changes (default: `false`). -- `RENOVATE_DEPENDENCY_DASHBOARD`: Set to `true` to enable the dependency - dashboard (default: `false`). The workflow runs on a schedule at 11:45 and 23:45 UTC every day. Both times fall outside the schedule windows in `renovate.json`, which all end @@ -351,12 +347,12 @@ Create the following required variables in the CircleCI project settings: - `RENOVATE_GIT_AUTHOR`: The author of Renovate commits in the format `Name `, such as `Renovate Bot `. -The following optional variables each have a default: +To test runs without making changes, also create `RENOVATE_DRY_RUN` and set +it to `true`. -- `RENOVATE_DRY_RUN`: Set to `true` to test runs without making changes - (default: `false`). -- `RENOVATE_DEPENDENCY_DASHBOARD`: Set to `true` to enable the dependency - dashboard (default: `false`). +To change `RENOVATE_PLATFORM`, `RENOVATE_AUTODISCOVER`, +`RENOVATE_DEPENDENCY_DASHBOARD_TITLE` or `LOG_LEVEL`, edit +`.circleci/update-dependencies.yml`. **Manual trigger:** trigger a pipeline from the CircleCI UI with the `run_update_dependencies` pipeline parameter set to `true`. The manual run @@ -401,6 +397,9 @@ Renovate has found. It groups them under headings such as these: To request an update early, tick its checkbox on the dashboard. +The `config:recommended` preset turns the dashboard on. To turn it off, set +`"dependencyDashboard": false` in `renovate.json`. + In self-hosted mode, the issue title names the CI provider that runs Renovate: diff --git a/.vortex/docs/content/development/variables.mdx b/.vortex/docs/content/development/variables.mdx index 2aa32ef22..97ab7fb63 100644 --- a/.vortex/docs/content/development/variables.mdx +++ b/.vortex/docs/content/development/variables.mdx @@ -214,7 +214,6 @@ The list below is automatically generated with [Shellvar](https://github.com/ale | `NEWRELIC_ENABLED` | Enable New Relic in Lagoon environment.

Set as project-wide variable. | `UNDEFINED` | `LAGOON ENVIRONMENT` | | `NEWRELIC_LICENSE` | New Relic license.

Set as project-wide variable. | `UNDEFINED` | `LAGOON ENVIRONMENT` | | `PACKAGE_TOKEN` | GitHub token used to overcome API rate limits or access private repositories. @see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token | `UNDEFINED` | `.env.local.example`, `scripts/vortex-tooling.sh` | -| `RENOVATE_DEPENDENCY_DASHBOARD` | Whether to enable self-hosted Renovate bot dashboard. | `false` | `CI config` | | `RENOVATE_DRY_RUN` | Whether to allow self-hosted Renovate bot make changes to the repository. | `false` | `CI config` | | `RENOVATE_GIT_AUTHOR` | Commit author for self-hosted Renovate bot. | `'Renovate Self Hosted '` | `CI config` | | `RENOVATE_REPOSITORIES` | Renovate repositories to manage. Set as "organization/repository". | `UNDEFINED` | `CI config` | diff --git a/.vortex/docs/cspell.json b/.vortex/docs/cspell.json index 2ab00ff61..579bcb502 100644 --- a/.vortex/docs/cspell.json +++ b/.vortex/docs/cspell.json @@ -7,6 +7,7 @@ "softwareTerms" ], "words": [ + "AUTODISCOVER", "Asciinema", "BROWSERTEST", "Buildx", diff --git a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.circleci/update-dependencies.yml b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.circleci/update-dependencies.yml index 262ec832b..e77f6583c 100644 --- a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.circleci/update-dependencies.yml +++ b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.circleci/update-dependencies.yml @@ -30,7 +30,7 @@ jobs: # - RENOVATE_TOKEN: GitHub access token. # - RENOVATE_REPOSITORIES: Repository to run Renovate on as `vendor/repository`. # - RENOVATE_GIT_AUTHOR: Author for Renovate commits as `Name `. - # Variables provided below can be overridden in the CircleCI project settings. + # Optionally, set RENOVATE_DRY_RUN to `true` to run without making changes. update-dependencies: docker: - image: renovate/renovate:__VERSION__ @@ -38,8 +38,6 @@ jobs: RENOVATE_PLATFORM: 'github' RENOVATE_AUTODISCOVER: false RENOVATE_DEPENDENCY_DASHBOARD_TITLE: 'Renovate Dependency Dashboard (self-hosted) by CircleCI' - RENOVATE_DEPENDENCY_DASHBOARD: false - RENOVATE_DRY_RUN: false LOG_LEVEL: 'debug' steps: diff --git a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.github/workflows/update-dependencies.yml b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.github/workflows/update-dependencies.yml index 2ec66781e..64614acd3 100644 --- a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.github/workflows/update-dependencies.yml +++ b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_circleci/.github/workflows/update-dependencies.yml @@ -76,7 +76,6 @@ jobs: RENOVATE_AUTODISCOVER: false RENOVATE_REPOSITORIES: ${{ vars.RENOVATE_REPOSITORIES || github.repository }} RENOVATE_DEPENDENCY_DASHBOARD_TITLE: 'Renovate Dependency Dashboard (self-hosted) by GitHub Actions' - RENOVATE_DEPENDENCY_DASHBOARD: ${{ vars.RENOVATE_DEPENDENCY_DASHBOARD || 'false' }} RENOVATE_DRY_RUN: ${{ vars.RENOVATE_DRY_RUN || 'false' }} RENOVATE_GIT_AUTHOR: ${{ vars.RENOVATE_GIT_AUTHOR }} RENOVATE_FORCE: ${{ github.event_name == 'workflow_dispatch' && inputs.preserve_schedules == false && '{"schedule":[],"prHourlyLimit":0,"branchConcurrentLimit":0}' || '' }} diff --git a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_gha/.github/workflows/update-dependencies.yml b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_gha/.github/workflows/update-dependencies.yml index 2ec66781e..64614acd3 100644 --- a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_gha/.github/workflows/update-dependencies.yml +++ b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_ci_gha/.github/workflows/update-dependencies.yml @@ -76,7 +76,6 @@ jobs: RENOVATE_AUTODISCOVER: false RENOVATE_REPOSITORIES: ${{ vars.RENOVATE_REPOSITORIES || github.repository }} RENOVATE_DEPENDENCY_DASHBOARD_TITLE: 'Renovate Dependency Dashboard (self-hosted) by GitHub Actions' - RENOVATE_DEPENDENCY_DASHBOARD: ${{ vars.RENOVATE_DEPENDENCY_DASHBOARD || 'false' }} RENOVATE_DRY_RUN: ${{ vars.RENOVATE_DRY_RUN || 'false' }} RENOVATE_GIT_AUTHOR: ${{ vars.RENOVATE_GIT_AUTHOR }} RENOVATE_FORCE: ${{ github.event_name == 'workflow_dispatch' && inputs.preserve_schedules == false && '{"schedule":[],"prHourlyLimit":0,"branchConcurrentLimit":0}' || '' }} diff --git a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_none/.github/workflows/update-dependencies.yml b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_none/.github/workflows/update-dependencies.yml index 2ec66781e..64614acd3 100644 --- a/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_none/.github/workflows/update-dependencies.yml +++ b/.vortex/installer/tests/Fixtures/handler_process/deps_updates_provider_none/.github/workflows/update-dependencies.yml @@ -76,7 +76,6 @@ jobs: RENOVATE_AUTODISCOVER: false RENOVATE_REPOSITORIES: ${{ vars.RENOVATE_REPOSITORIES || github.repository }} RENOVATE_DEPENDENCY_DASHBOARD_TITLE: 'Renovate Dependency Dashboard (self-hosted) by GitHub Actions' - RENOVATE_DEPENDENCY_DASHBOARD: ${{ vars.RENOVATE_DEPENDENCY_DASHBOARD || 'false' }} RENOVATE_DRY_RUN: ${{ vars.RENOVATE_DRY_RUN || 'false' }} RENOVATE_GIT_AUTHOR: ${{ vars.RENOVATE_GIT_AUTHOR }} RENOVATE_FORCE: ${{ github.event_name == 'workflow_dispatch' && inputs.preserve_schedules == false && '{"schedule":[],"prHourlyLimit":0,"branchConcurrentLimit":0}' || '' }}