Run Renovate locally (#193)

* update * update * update * update * update
stakater · Dec 21, 2023 · e681abe · e681abe
1 parent f691c57
commit e681abe
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 3 deletions.
diff --git a/content/about/saap-key-differentiators.md b/content/about/saap-key-differentiators.md
@@ -4,7 +4,7 @@ Stakater App Agility Platform is a true hybrid-cloud enabler. All components of
 
 - We support infra nodes, i.e. we fully manage nodes that run all managed addons of your choice.
 - We manage the addons as well; and provide SLA on them.
-- We support public clouds (AWS, Azure, Google, OpenStack & VMWare) as well as on-premises.
+- We support public clouds (AWS, Azure, Google, OpenStack & VMware) as well as on-premises.
 - Our SREs have full-stack development experience; so they understand the needs of applications and their runtimes.
 - A managed container orchestration platform is much more than making an API available: it is an environment designed with client support and acceleration in mind
 - Having a fully automated and industrialized systems management is the only way to reduce operative risks, keep costs under control, reinforce security and scale with guarantees

diff --git a/content/index.md b/content/index.md
@@ -10,7 +10,7 @@ Companies require a solution with a justifiable return on their investment.
 
 ![Stakater App Agility Platform](./about/images/saap.jpg)
 
-Built by open source leaders, Red Hat® OpenShift® is the leading enterprise Kubernetes platform. Stakater App Agility Platform is a fully managed enterprise Kubernetes platform hosted on AWS, Google, Azure, VMWare & OpenStack. With Stakater App Agility Platform, innovators can focus on what matters, stay competitive, and outpace rising customer expectations without worrying about managing the underlying infrastructure.
+Built by open source leaders, Red Hat® OpenShift® is the leading enterprise Kubernetes platform. Stakater App Agility Platform is a fully managed enterprise Kubernetes platform hosted on AWS, Google, Azure, VMware & OpenStack. With Stakater App Agility Platform, innovators can focus on what matters, stay competitive, and outpace rising customer expectations without worrying about managing the underlying infrastructure.
 
 With Stakater App Agility Platform, Stakater builds and manages your OpenShift clusters, allowing you to focus on your business. Stakater offers Stakater App Agility Platform for on-premises or your choice of public cloud allowing you to optimize your multi-cloud strategy that best suits your needs. Stakater App Agility Platform enables your teams across your organizations to consume OpenShift as a Service.
 

diff --git a/content/managed-addons/renovate/how-to-guides/run-locally.md b/content/managed-addons/renovate/how-to-guides/run-locally.md
@@ -0,0 +1,35 @@
+# Local development
+
+Sometimes you need to run Renovate locally to be able to troubleshoot issues or verify local configurations.
+
+## Config validation
+
+To validate your Renovate configuration:
+
+1. Install Renovate locally
+1. Run `renovate-config-validator <config-file>`, for example:
+
+    ```sh
+    $ renovate-config-validator renovate.json
+    DEBUG: Using RE2 as regex engine
+    (node:15692) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
+    (Use `node --trace-deprecation ...` to show where the warning was created)
+    INFO: Validating renovate.json
+    INFO: Config validated successfully
+    ```
+
+## Run Renovate locally
+
+To run Renovate locally:
+
+1. Install Renovate locally: `brew install renovate`
+
+1. If you use encrypted secrets in the configuration and you want to use the local configuration file, you need to create locally encrypted secrets
+    1. Create a local copy of the index file in [Mend Renovate App secrets encryption](https://app.renovatebot.com/encrypt)
+    1. Replace the public key in the local html, see [`privateKey` config](https://docs.renovatebot.com/self-hosted-configuration/#privatekey)
+    1. Encrypt any passwords and replace them temporarily in the local config file
+    1. `RENOVATE_CONFIG_FILE` should point to the local config file
+    1. `RENOVATE_PRIVATE_KEY_PATH` must be set
+1. `RENOVATE_TOKEN` need to be created and set
+1. `LOG_LEVEL` should be set as applicable
+1. Run a dry-run from anywhere because it clones the repo in a cached location: `renovate --dry-run="full" --require-config="ignored" "stakater/saap-docs"`
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -238,6 +238,7 @@ nav:
             - managed-addons/renovate/overview.md
             - How-to guides:            
                 - managed-addons/renovate/how-to-guides/automerge.md
+                - managed-addons/renovate/how-to-guides/run-locally.md
         - Gatekeeper:
             - managed-addons/gatekeeper/overview.md
         - Showback:

diff --git a/renovate.json b/renovate.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "config:base"
+    "config:recommended"
   ]
 }