renovatebot / renovatebot.github.io Goto Github PK

Auto-generating docs repository for Renovate Bot

CSS 4.02% Makefile 10.33% Shell 29.88% TypeScript 32.55% Python 4.52% HTML 11.31% Dockerfile 7.40%

renovatebot.github.io's Introduction

docs.renovatebot.com

This repository is used to build Renovate's docs site (https://docs.renovatebot.com).

The content itself is pulled from https://github.com/renovatebot/renovate, so you should raise PRs to that repository if you need to update the content that's displayed.

The website is built and hosted by GitHub Pages.

To build locally, run make and then make serve.

Contributing

If you would like to contribute to this repository or get a local copy running for some other reason, please see the instructions in .github/contributing.md.

Security / Disclosure

If you find any bug with Renovate that may be a security problem, then e-mail us at: [email protected]. This way we can evaluate the bug and hopefully fix it before it gets abused. Please give us enough time to investigate the bug before you report it anywhere else.

Please do not create GitHub issues for security-related doubts or problems.

renovatebot.github.io's People

Contributors

Stargazers

Watchers

renovatebot.github.io's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

chore(deps): update pnpm/action-setup action to v4

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

chore(deps): lock file maintenance

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

chore(docs): update deps/renovate digest to 676e1ef
chore(deps): update actions/checkout action to v4.1.6
chore(deps): update pnpm to v9.1.1
fix(deps): update dependency mkdocs-material to v9.5.23
chore(deps): update python docker tag to v3.12

Detected dependencies

dockerfile

.devcontainer/Dockerfile

ghcr.io/containerbase/devcontainer 10.6.10

.gitpod/Dockerfile

ghcr.io/containerbase/gitpod 10.6.10

git-submodules

.gitmodules

deps/renovate main@cc5da0b7b403da06a589ae123da3f76077077682

github-actions

.github/workflows/devcontainer.yml

actions/checkout v4.1.5@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b

devcontainers/ci v0.3.1900000349@a56d055efecd725e8cfe370543b6071b79989cc8

.github/workflows/lock.yml

dessant/lock-threads v5.0.1@1bf7ec25051fe7c00bdd17e6a7cf3d7bfb7dc771

.github/workflows/publish-docs.yml

actions/checkout v4.1.5@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b

pnpm/action-setup v3.0.0@a3252b78c470c02df07e9d59298aecedc3ccdd6d

actions/setup-node v4.0.2@60edb5dd545a775178f52524783378180af0d1f8

actions/setup-python v5.1.0@82c7e631bb3cdc910f68e0081d67478d79c6982d

actions/cache v4.0.2@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

reviewdog/action-shellcheck v1.20.0@72365a51bf6476fe952a117c3ff703eb7775e40a

actions/upload-artifact v4.3.3@65462800fd760344b1a7b4382951275a0abb4808

cypress-io/github-action v6.6.1@1b70233146622b69e789ccdd4f9452adc638d25a

actions/upload-artifact v4.3.3@65462800fd760344b1a7b4382951275a0abb4808

nodenv

.node-version

node 20.13.1

npm

deps/cache-decoder/package.json

brotli 1.3.3

buffer 6.0.3

parcel 2.12.0

path-browserify 1.0.1

process 0.11.10

package.json

@testing-library/cypress 10.0.1

cypress 13.9.0

husky 9.0.11

lint-staged 15.2.2

prettier 3.2.5

prettier-plugin-packagejson 2.5.0

typescript 5.4.5

node ^18.12.0 || >=20.9.0

pnpm ^9.0.0

pnpm 9.1.0

pep621

pyproject.toml

poetry

pyproject.toml

python >=3.11

mkdocs-material ==9.5.22

mkdocs-awesome-pages-plugin ==2.9.2

pyenv

.python-version

python 3.12.3

regex

.devcontainer/Dockerfile

poetry 1.8.3

.gitpod/Dockerfile

poetry 1.8.3

bin/prepare-vercel.sh

python 3.11

poetry 1.8.3

.github/workflows/publish-docs.yml

poetry 1.8.3

Check this box to trigger a request for Renovate to run again on this repository

Display open issue list on each module page

What would you like to be able to do?

I would like it that module pages like gradle manager or pep440 versioning include a table of open issues linked to their source. This way people browsing the documentation for a manager are more likely to see if there are open feature requests or bug reports for the manager which might affect them.

Did you already have any implementation ideas?

First of all, these lists would depend on us maintaining healthy labeling in renovatebot/renovate:

Needs to have the exact match label
Should not be in triage priority (triage issues are excluded/0

Three possible ways I can think of to fetch and build the list:

It could be done as part of our existing docs build in renovatebot/renovate. The problem with this is that the docs artifact we generate would be out of date within minutes or hours of it being published, so it doesn't seem like a good approach. The docs build therefore should include some form of "placeholder" for open issues
We could fetch the issue list with each build in this repo. It could still be out of date, but much less of a problem
We could use client-side JS to dynamically fetch/build the list using the user's browser. Problem here is (a) complexity of adding client JS, (b) rate limiting

Therefore the 2nd approach sounds best, potentially combined with cron schedules for extra builds.

Do you want to write this feature yourself?

Yes

Tasks

renovatebot/renovate#15546

docs "Default Presets" page is 404

It seems that "Default Presets" page in renovate documents site ( https://docs.renovatebot.com/presets-default/ ) returns 404:

curl result

<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      <meta http-equiv="x-ua-compatible" content="ie=edge">
      
      
      
      
        <meta name="lang:clipboard.copy" content="Copy to clipboard">
      
        <meta name="lang:clipboard.copied" content="Copied to clipboard">
      
        <meta name="lang:search.language" content="en">
      
        <meta name="lang:search.pipeline.stopwords" content="True">
      
        <meta name="lang:search.pipeline.trimmer" content="True">
      
        <meta name="lang:search.result.none" content="No matching documents">
      
        <meta name="lang:search.result.one" content="1 matching document">
      
        <meta name="lang:search.result.other" content="# matching documents">
      
        <meta name="lang:search.tokenizer" content="[\s\-]+">
      
      <link rel="shortcut icon" href="assets/images/logo.png">
      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.1">
    
    
      
        <title>Renovate Docs</title>
      
    
    
      <link rel="stylesheet" href="assets/stylesheets/application.30686662.css">
      
        <link rel="stylesheet" href="assets/stylesheets/application-palette.a8b3c06d.css">
      
      
        
        
        <meta name="theme-color" content="#2196f3">
      
    
    
      <script src="assets/javascripts/modernizr.74668098.js"></script>
    
    
      
        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
      
    
    <link rel="stylesheet" href="assets/fonts/material-icons.css">
    
    
      <link rel="stylesheet" href="assets/css/style.css">
    
    
      
    
    
  </head>
  
    
    
    <body dir="ltr" data-md-color-primary="blue" data-md-color-accent="blue">
  
    <svg class="md-svg">
      <defs>
        
        
      </defs>
    </svg>
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
    
    
      <header class="md-header" data-md-component="header">
  <nav class="md-header-nav md-grid">
    <div class="md-flex">
      <div class="md-flex__cell md-flex__cell--shrink">
        <a href="https://docs.renovatebot.com" title="Renovate Docs" class="md-header-nav__button md-logo">
          
            <img src="assets/images/logo.png" width="24" height="24">
          
        </a>
      </div>
      <div class="md-flex__cell md-flex__cell--shrink">
        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
      </div>
      <div class="md-flex__cell md-flex__cell--stretch">
        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
          
            <span class="md-header-nav__topic">
              Renovate Docs
            </span>
            <span class="md-header-nav__topic">
              
                
              
            </span>
          
        </div>
      </div>
      <div class="md-flex__cell md-flex__cell--shrink">
        
          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
          
<div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
      <label class="md-icon md-search__icon" for="__search"></label>
      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
        &#xE5CD;
      </button>
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" data-md-scrollfix>
        <div class="md-search-result" data-md-component="result">
          <div class="md-search-result__meta">
            Type to start searching
          </div>
          <ol class="md-search-result__list"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
        
      </div>
      
    </div>
  </nav>
</header>
    
    <div class="md-container">
      
        
      
      
      <main class="md-main">
        <div class="md-main__inner md-grid" data-md-component="container">
          
            
              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    <nav class="md-nav md-nav--primary" data-md-level="0">
  <label class="md-nav__title md-nav__title--site" for="__drawer">
    <a href="https://docs.renovatebot.com" title="Renovate Docs" class="md-nav__button md-logo">
      
        <img src="assets/images/logo.png" width="48" height="48">
      
    </a>
    Renovate Docs
  </label>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
      
      


  <li class="md-nav__item">
    <a href="." title="Home" class="md-nav__link">
      Home
    </a>
  </li>

    
      
      
      


  <li class="md-nav__item md-nav__item--nested">
    
      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
    
    <label class="md-nav__link" for="nav-2">
      Getting Started
    </label>
    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
      <label class="md-nav__title" for="nav-2">
        Getting Started
      </label>
      <ul class="md-nav__list" data-md-scrollfix>
        
        
          
          
          


  <li class="md-nav__item">
    <a href="install-github-app/" title="GitHub App Installation" class="md-nav__link">
      GitHub App Installation
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="install-gitlab-app/" title="GitLab App Installation" class="md-nav__link">
      GitLab App Installation
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="configure-renovate/" title="Configure Renovate (Onboarding PR)" class="md-nav__link">
      Configure Renovate (Onboarding PR)
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="private-modules/" title="Private npm module support" class="md-nav__link">
      Private npm module support
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="reconfigure-renovate/" title="Reconfiguring Renovate" class="md-nav__link">
      Reconfiguring Renovate
    </a>
  </li>

        
      </ul>
    </nav>
  </li>

    
      
      
      


  <li class="md-nav__item">
    <a href="configuration-options/" title="Configuration Options" class="md-nav__link">
      Configuration Options
    </a>
  </li>

    
      
      
      


  <li class="md-nav__item">
    <a href="self-hosted-configuration/" title="Self Hosted Configuration" class="md-nav__link">
      Self Hosted Configuration
    </a>
  </li>

    
      
      
      


  <li class="md-nav__item md-nav__item--nested">
    
      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
    
    <label class="md-nav__link" for="nav-5">
      Renovate Modules
    </label>
    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
      <label class="md-nav__title" for="nav-5">
        Renovate Modules
      </label>
      <ul class="md-nav__list" data-md-scrollfix>
        
        
          
          
          


  <li class="md-nav__item">
    <a href="modules/platform/" title="Platforms" class="md-nav__link">
      Platforms
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="modules/manager/" title="Managers" class="md-nav__link">
      Managers
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="modules/datasource/" title="Datasources" class="md-nav__link">
      Datasources
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="modules/versioning/" title="Versioning" class="md-nav__link">
      Versioning
    </a>
  </li>

        
      </ul>
    </nav>
  </li>

    
      
      
      


  <li class="md-nav__item">
    <a href="config-presets/" title="Shareable Config Presets" class="md-nav__link">
      Shareable Config Presets
    </a>
  </li>

    
      
      
      


  <li class="md-nav__item md-nav__item--nested">
    
      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
    
    <label class="md-nav__link" for="nav-7">
      Language Support
    </label>
    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
      <label class="md-nav__title" for="nav-7">
        Language Support
      </label>
      <ul class="md-nav__list" data-md-scrollfix>
        
        
          
          
          


  <li class="md-nav__item">
    <a href="bazel/" title="Bazel" class="md-nav__link">
      Bazel
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="docker/" title="Docker" class="md-nav__link">
      Docker
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="golang/" title="Golang" class="md-nav__link">
      Golang
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="java/" title="Java" class="md-nav__link">
      Java
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="javascript/" title="JavaScript" class="md-nav__link">
      JavaScript
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="node/" title="Node.js Versions" class="md-nav__link">
      Node.js Versions
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="nuget/" title="Nuget" class="md-nav__link">
      Nuget
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="php/" title="PHP" class="md-nav__link">
      PHP
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="python/" title="Python" class="md-nav__link">
      Python
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="ruby/" title="Ruby" class="md-nav__link">
      Ruby
    </a>
  </li>

        
      </ul>
    </nav>
  </li>

    
      
      
      


  <li class="md-nav__item md-nav__item--nested">
    
      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
    
    <label class="md-nav__link" for="nav-8">
      Deep Dives
    </label>
    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
      <label class="md-nav__title" for="nav-8">
        Deep Dives
      </label>
      <ul class="md-nav__list" data-md-scrollfix>
        
        
          
          
          


  <li class="md-nav__item">
    <a href="dependency-pinning/" title="Should you Pin your Javascript Dependencies?" class="md-nav__link">
      Should you Pin your Javascript Dependencies?
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="configuration-templates/" title="Config Template Editing" class="md-nav__link">
      Config Template Editing
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="updating-rebasing/" title="Updating and Rebasing Branches" class="md-nav__link">
      Updating and Rebasing Branches
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="semantic-commits/" title="Semantic Commit Messages" class="md-nav__link">
      Semantic Commit Messages
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="noise-reduction/" title="Noise Reduction" class="md-nav__link">
      Noise Reduction
    </a>
  </li>

        
      </ul>
    </nav>
  </li>

    
      
      
      


  <li class="md-nav__item md-nav__item--nested">
    
      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
    
    <label class="md-nav__link" for="nav-9">
      Config Presets
    </label>
    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
      <label class="md-nav__title" for="nav-9">
        Config Presets
      </label>
      <ul class="md-nav__list" data-md-scrollfix>
        
        
          
          
          


  <li class="md-nav__item">
    <a href="presets-config/" title="Full Config Presets" class="md-nav__link">
      Full Config Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-default.md" title="Default Presets" class="md-nav__link">
      Default Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-docker/" title="Docker Presets" class="md-nav__link">
      Docker Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-group/" title="Group Presets" class="md-nav__link">
      Group Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-helpers/" title="Helper Presets" class="md-nav__link">
      Helper Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-js/" title="JS Presets" class="md-nav__link">
      JS Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-meteor/" title="Meteor Presets" class="md-nav__link">
      Meteor Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-monorepo/" title="Monorepo Presets" class="md-nav__link">
      Monorepo Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-packages/" title="Package Presets" class="md-nav__link">
      Package Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-preview/" title="Preview Presets" class="md-nav__link">
      Preview Presets
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="presets-schedule/" title="Schedule Presets" class="md-nav__link">
      Schedule Presets
    </a>
  </li>

        
      </ul>
    </nav>
  </li>

    
      
      
      


  <li class="md-nav__item md-nav__item--nested">
    
      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
    
    <label class="md-nav__link" for="nav-10">
      WhiteSource Renovate On-Premises
    </label>
    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
      <label class="md-nav__title" for="nav-10">
        WhiteSource Renovate On-Premises
      </label>
      <ul class="md-nav__list" data-md-scrollfix>
        
        
          
          
          


  <li class="md-nav__item">
    <a href="pro/overview/" title="Overview" class="md-nav__link">
      Overview
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="pro/configuration-github/" title="Configuration (GitHub)" class="md-nav__link">
      Configuration (GitHub)
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="pro/configuration-gitlab/" title="Configuration (GitLab)" class="md-nav__link">
      Configuration (GitLab)
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="pro/advanced/" title="Advanced Details" class="md-nav__link">
      Advanced Details
    </a>
  </li>

        
      </ul>
    </nav>
  </li>

    
      
      
      


  <li class="md-nav__item md-nav__item--nested">
    
      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11">
    
    <label class="md-nav__link" for="nav-11">
      All Other
    </label>
    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
      <label class="md-nav__title" for="nav-11">
        All Other
      </label>
      <ul class="md-nav__list" data-md-scrollfix>
        
        
          
          
          


  <li class="md-nav__item">
    <a href="templates/" title="Templates" class="md-nav__link">
      Templates
    </a>
  </li>

        
          
          
          


  <li class="md-nav__item">
    <a href="faq/" title="Frequently Asked Questions (FAQ)" class="md-nav__link">
      Frequently Asked Questions (FAQ)
    </a>
  </li>

        
      </ul>
    </nav>
  </li>

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
          
          <div class="md-content">
            <article class="md-content__inner md-typeset">
              
  <h1>404 - Not found</h1>

              
                


              
            </article>
          </div>
        </div>
      </main>
      
        
<footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-footer-copyright">
        
        powered by
        <a href="https://www.mkdocs.org">MkDocs</a>
        and
        <a href="https://squidfunk.github.io/mkdocs-material/">
          Material for MkDocs</a>
      </div>
      
    </div>
  </div>
</footer>
      
    </div>
    
      <script src="assets/javascripts/application.c648116f.js"></script>
      
      <script>app.initialize({version:"1.0.4",url:{base:""}})</script>
      
        <script src="assets/js/fx.js"></script>
      
    
  </body>
</html>

I apologize if this issue was made in wrong repo. I don't know how to build the docs.

FYI the contents on Google webcache:

Replace `yarn build:docs` with proper command in `get-docs.sh` script

Describe the proposed change(s).

renovatebot.github.io/bin/get-docs.sh

Lines 15 to 18 in 38aae67

    
           if [ -z "$SKIP_BUILD" ]; then 
        
             yarn install --frozen-lockfile 
        
             yarn build:docs 
        
           fi

The yarn build:docs command listed above doesn't work.

We have three scripts in our package.json now:

renovatebot.github.io/package.json

Lines 14 to 18 in 38aae67

    
           "scripts": { 
        
             "prepare": "husky install", 
        
             "prettier": "prettier --check --ignore-unknown \"**/*.*\"", 
        
             "prettier-fix": "prettier --write --ignore-unknown \"**/*.*\"" 
        
           },

We should update our get-docs.sh script so it works again. 😉

Use released docs package from renovate to generate docs

What would you like to be able to do?

We should use the now released precompiled renovate docs asset instead of the git submodule.
This will speedup docs generation.
Dowside: we need a renovate release to update docs.

Did you already have any implementation ideas?

remove submodule
add renovate version to a file and let renovate selfupdate
download file in get-docs
optional allow setting an env to use local docs from renovate repo outside of this repo for debugging

Enable emoji support

Describe the proposed change(s).

Material for MkDocs supports emoji's ¹, but we need to enable some extensions first.

Todo:

Enable relevant extensions
Preview site locally, confirm it works
Check other things keep working
Open PR

Material for MkDocs manual, icons/emojis ↩

Add basic Gitpod configuration to this repository

What would you like to be able to do?

I'd like to be able to get started with Gitpod on this repository in an easy way. Right now I have to run some steps/configuration manually, and it's a bit of a chore to have to keep doing this every time. 😄

Did you already have any implementation ideas?

If you want, I can make a basic Gitpod configuration file, that will run the make and mkdocs serve steps automatically whenever somebody opens a new Gitpod workspace.

TODOs:

Create Gitpod configuration
Update relevant development documentation to point out Gitpod

Add automerge configuration guide to sidebar

@viceice mentioned we need to make some changes in this repository to get the new automerge configuration guide (renovatebot/renovate#7724) in the sidebar of the Renovate documentation site?

I can find the new docs with the search function, but I don't see it in the sidebar when I fully expand all items in the sidebar.
Am I maybe missing it?

Link to public docs: https://docs.renovatebot.com/automerge-configuration/

To reproduce:

Go to Renovate Docs homepage.
Expand all sidebar items.
Search for automerge in your browser, get 0 hits.

Enable syntax highlight

What would you like to be able to do?

I want to use syntax highlighting, so that the code examples use colors for the code/keywords.

Did you already have any implementation ideas?

I already tried the syntax highlighting, but it breaks our presets-config page, due to some bad input.
Once the bad input is fixed we can enable highlighting again.

renovatebot/renovate#13348 <--- This issue needs to be fixed first
Wait until Renovate bot updates us to the submodule of renovatebot/renovate that includes the fix
Enable syntax highlighting by putting - pymdownx.highlight and - pymdownx.superfences in the markdown_extensions: array of the mkdocs.yml config file, see: #126

Add `security-and-permissions.md` to sidebar

What would you like to be able to do?

Add security-and-permissions.md file to the sidebar.

Follow up for renovatebot/renovate#13748.

Did you already have any implementation ideas?

When we see the file on our main branch we can add it in the sidebar and check the preview locally.

Improve Renovate update config for `mkdocs-material`

What would you like to be able to do?

Right now I have to manually request updates to mkdocs-material, for minor bumps from the maintainers of this repository.

I don't know what the original reasoning was to require dashboard approval for minor Python package updates?

I would much rather have Renovate open update PRs for mkdocs-material automatically, and then wait for our approval. This would reduce the need for me to bother you to update. 😄

Did you already have any implementation ideas?

We get our Renovate config from two places:

Global config: https://github.com/renovatebot/.github/blob/main/default.json
Local config: https://github.com/renovatebot/renovatebot.github.io/blob/main/renovate.json

I think we can make a custom packageRule for just mkdocs-material and put it at the bottom of the packageRules array?

I was thinking of defining the rules for mkdocs-material like this:

Keep stabilityDays at 3
Always open a PR for all update types automatically, even for major updates
Always require PR approval
Optional: automerge patch level updates "behind our back" via branch automerge, like we do now already

Let me know what you think of this idea, and what rules you would like to have?

Add automated tests?

What would you like to be able to do?

When I made PR #97, I forgot to check the display of our config presets page. This means we deployed a change that was not ready for production. 😞

It easy to miss bad changes like this when testing manually. It also means that updates to Material for MkDocs are risky.

I would like to have some automated tests that check for visual changes, so that unintended visual regressions are caught by the machine.

I would also like to have some basic tests that check if things like search, sidebar items, previous page/next page button, light/dark mode all work properly.

Did you already have any implementation ideas?

We could probably use Cypress ¹ to test the functionality of our docs pages.

I'm not really familiar with any way to test for visual changes yet.

https://www.cypress.io/ ↩

Display supportsLockFileMaintenance status

https://github.com/renovatebot/renovate/search?q=supportsLockFileMaintenance&unscoped_q=supportsLockFileMaintenance

Use reviewdog/action-shellcheck

What would you like to be able to do?

We should use the reviewdog/action-shellcheck github action for shell check to have nice annotations

Did you already have any implementation ideas?

Add documentation for templates and parameters

Describe which fields can be templates and use the exported values from https://github.com/renovatebot/renovate/blob/139e8bb2c2aa0d190c3b95a659189d1c2b3b76d5/lib/util/template/index.ts#L13-L78 to automatically document the available values.

Documentation for configuring renovate through environment variables

Which Renovate are you using?

Renovate Open Source CLI

Which platform are you using?

GitLab.com

What would you like to do?

Is there an exhaustive documentation on which environment variables to use to configure renovate? For example, renovatebot/renovate#4984 indicates that you can set a RENOVATE_HOST_RULES env var. Also, GITHUB_COM_TOKEN and RENOVATE_TOKEN seem like valid options here.

However, I cannot find any documentation on this. I checked configuration options, self-hosted configuration options and pretty much every other site in the documentation. Am I missing something?

I am particularly interested in knowing how to set the repositories property, as described here.

Use caching features in `actions/setup-node` and `actions/setup-python`

What would you like to be able to do?

Right now we're manually caching dependencies in our GitHub Action workflow files.
actions/setup-node ¹ and actions/setup-python ² now come with built-in caching.

Did you already have any implementation ideas?

renovatebot.github.io/.github/workflows/publish-docs.yml

Lines 51 to 65 in c65599c

    
                 - name: Cache Yarn packages 
        
                   uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed # renovate: tag=v2.1.7 
        
                   with: 
        
                     path: ${{ steps.init.outputs.yarn_cache }} 
        
                     key: ${{ runner.os }}-yarn_cache-${{ hashFiles('**/yarn.lock') }} 
        
                     restore-keys: | 
        
                       ${{ runner.os }}-yarn_cache- 
        
                 - name: Cache pip packages 
        
                   uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed # renovate: tag=v2.1.7 
        
                   with: 
        
                     path: ${{ steps.init.outputs.pip_cache }} 
        
                     key: ${{ runner.os }}-${{ env.python-version }}-pip-${{ hashFiles('**/requirements.txt') }} 
        
                     restore-keys: | 
        
                       ${{ runner.os }}-${{ env.python-version }}-pip-

We can probably replace the manual caching steps with the built-in caching in the code above.

Add custom `edit_url` for the Merge Confidence page

What would you like to be able to do?

The pencil/edit button on the Merge Confidence page in our docs doesn't point to the correct location.

The documentation build pulls in the README.md file from whitesource/merge-confidence. This means our default "edit button link" doesn't work for this page. We can fix this by using the new edit_url hook.

Did you already have any implementation ideas?

Put this front matter in the code that we use to load in the README.md from the whitesource/merge-confidence repository:

---
edit_url: https://github.com/whitesource/merge-confidence/edit/main/README.md
---

We should probably update these lines of code:

renovatebot.github.io/bin/get-docs.sh

Lines 25 to 26 in a6b1afc

    
           printf -- '---\ntitle: Merge Confidence\ndescription: Node versions support in Renovate\n---\n\n' > docs/merge-confidence.md 
        
           curl -sSLf https://raw.githubusercontent.com/whitesource/merge-confidence/main/README.md >> docs/merge-confidence.md

Do you want to write this feature yourself?

Move `src/index.md` page to main Renovate repository?

What would you like to be able to do?

It's a bit confusing that the homepage/index is in the renovatebot.github.io repo.

This has a few drawbacks:

You cannot suggest changes to the homepage via the "pencil" button on the published docs homepage (because the file is not in the main renovatebot repo)
It splits the documentation into two parts
It also means that the "publish docs as assets" is missing a suitable index/homepage/startpoint as well

I think our overall goal is to move all the docs back to the main renovate repository, build the docs over there, and import the docs/asset files into the docs-building repo?

Did you already have any implementation ideas?

Maybe we can move the src/index.md file to a suitable place in the main Renovate bot repository, and then make it so that mkdocs understands where to find/insert the homepage in the docs building step in our makefile?

I'm talking about this file: https://github.com/renovatebot/renovatebot.github.io/blob/main/src/index.md

setup Prettier + create GitHub Action that lints with Prettier?

Do we want to setup a Prettier configuration + CI that checks for Prettier errors on this repo?
I use Prettier to good effect on my simple Docusaurus v2 repo, but it might get complicated due to some autogenerating content.

Somebody who knows how the build process works should set up the prettierignore file so that we're only prettifying things we care about.

Sidebar item visiblity

What would you like to be able to do?

We're currently hiding items in the sidebar by default.
This can cause users to miss useful information like the "Versioning" help in the docs/usage/modules/versioning.md file.
So maybe we want to just show all items and not hide anything for now.

Once we migrate to Docusaurus v2 we have a lot more control over what items we want to be visible in the sidebar and which we want to hide: https://v2.docusaurus.io/docs/sidebar#expanded-categories-by-default

Did you already have any implementation ideas?

I have checked the MkDocs documentation, and I don't know if the current theme we're using supports the navigation_depth property or not.

navigation_depth: The maximum depth of the navigation tree in the sidebar. Default: 2.

I was thinking we could increase the maximum depth of the tree to get more items to be visible on the sidebar.
See https://www.mkdocs.org/user-guide/styling-your-docs/#mkdocs and search on the page for navigation_depth to find the docs for this property.

We can also wait with this change until we've migrated to Docusaurus v2.

chore: setup semantic commit bot

What would you like to be able to do?

It might be nice to check if the PR titles are using Semantic Commits on this repo as well?
That would prepare us for if we ever want to release versioned docs (though this is hard to to in Docusaurus v2, and not recommended by the Docusaurus devs...)

If anything, having semantic commits will probably make it easier to search the logs for relevant changes.
And we're then consistent with the format we use for the main Renovate bot repo.

Did you already have any implementation ideas?

We could copy/paste the semantic bot from: https://github.com/renovatebot/renovate/blob/master/.github/semantic.yml
The repository admin probably needs to tinker in some configuration menu for the bot, to ensure the bot is allowed to run on this repo.

Add dashboard page to getting started section

What would you like to be able to do?

See renovatebot/renovate#11178 and renovatebot/renovate#11183

Did you already have any implementation ideas?

Maybe update the issue discussion lock bot?

I noticed we have a bot that locks further discussion on closed issues after 7 days: https://github.com/renovatebot/renovatebot.github.io/blob/build/.github/lock.yml

Maybe you should use the GitHub Actions based bot instead of the current bot?

From https://github.com/dessant/lock-threads-app/blob/master/README.md:

This project is in maintenance mode, migrating to the version built on GitHub Actions is recommended: https://github.com/dessant/lock-threads

Create issue templates

I was thinking about making a PR to create issue templates for bugs and feature requests.
But then I realized that I don't know what those issue templates should cover.... 😄

I think in the end, once we've migrated to Docusaurus, the main things we would probably handle on this repository are:

Styling bugs
Usability concerns
Broken stuff due to the migration process
Missing stuff due to the migration process
Maybe security bugs related to Docusaurus (those should go upstream to Docusaurus themselves probably).

Maybe we should wait a bit until we are clear on what this repo is going to contain before creating issue templates?

Add sidebar link to `replacement` presets

What would you like to be able to do?

Add sidebar link to replacement presets

Did you already have any implementation ideas?

Dependent on renovatebot/renovate#5558

Publish security.txt file

What would you like to be able to do?

Publish a security.txt file as an extra way for people to find out about our security policy.

Inspired by @astellingwerf's comment: ¹

Would it be worth also advertising this information in a .well-known/security.txt a la https://securitytxt.org/?

Did you already have any implementation ideas?

Find way to publish the .txt file in the expected place.

https://github.com/renovatebot/renovate/pull/14570#discussion_r825027999 ↩

Supported Datasources documentation missing

In the Renovate Docs under Renovate Modules > Datasources. The expected content under the Supported Datasources heading is missing.

https://docs.renovatebot.com/modules/datasource/#supported-datasources

https://github.com/renovatebot/renovate/blob/master/docs/usage/modules/datasource.md

Some documentation searches are giving misleading results

How are you running Renovate?

WhiteSource Renovate hosted app on github.com

If you're self-hosting Renovate, tell us what version of Renovate you run.

No response

Please select which platform you are using if self-hosting.

No response

If you're self-hosting Renovate, tell us what version of the platform you run.

No response

Was this something which used to work for you, and then stopped?

I never saw this working

Describe the bug

For example if you search for "depTypes":

the results show "File Matching" as the header, even though the results are pointing to specific manager documentations:

I would expect "Automated Dependency Updates for Pipenv" to show instead for the first result for example.

Relevant debug logs

N/A

Have you created a minimal reproduction repository?

No reproduction, but I have linked to a public repo where it occurs

Migrate to Docusaurus v2

I think the plan is to migrate to Docusaurus v2 within this repository.
We previously linked to renovatebot/docs.renovatebot.com#9 but that was a mistake.

Use new About Us page

Describe the proposed change(s).

We merged renovatebot/renovate#15661 which created a new about-us.md file in a new location.

Todos:

Wait until Renovate bot updates our Git submodule for renovatebot/renovate
Change nav in mkdocs for the About Us page so it points to the docs/usage/about-us.md file
Remove the old about-us.md in the src directory
Check with site preview if it all still works
Create PR

refactor workflows to deploy only when cypress tests pass

Ref : @viceice 's comment

Task:
Refactor workflow, so that we only deploy the docs when cypress tests pass.

Implementation Idea:

Combine both workflows ie. cypress and publish-docs.

There are duplicate steps in the workflows so deleting the cypress-tests workflow and adding the cypress run step to the publish-docs workflow will save some minutes.
Add cypress run step before the publish-docs step && use steps context so that when tests fail publish-docs doesn't run.

Github mixed with Gitlab - Typo?

This is the page about Gitlab app Installation https://docs.renovatebot.com/install-gitlab-app/#configuring-a-token-for-githubcom-hosted-release-notes, but there is header of section talking about GitHub.

Is that just a typo, or wrong placed part of the documentation?

Use `pip-compile` to pin transitive pip deps

What would you like to be able to do?

We should use pip-compile to pin transitive deps, to not get issues like:

#153

Did you already have any implementation ideas?

Yes:

copy requirements.txt to requirements.in
enable pip-compile and disable pip_requirements in renovate.json

Fix bash scripts to conform to ShellCheck rules

What browser are you using?

Not relevant to report.

Describe the bug

Shell Check program/website reports problems with our .sh scripts.

Steps to reproduce

Go to https://github.com/renovatebot/renovatebot.github.io/tree/main/bin
Copy/paste the shell script code into the ShellCheck website. ¹
See problems for at least the bin/get-docs.sh file.

Additional context

We should follow the best practices from the ShellCheck website.

https://www.shellcheck.net/ ↩

Require branches to be up to date before merging?

The main Renovate bot repo has The Require branches to be up to date before merging checkbox ticked on the Branch Protection tab in the repo settings.

It might be a good idea to enforce the integration of the mainline branch into the PR branch on this repository as well.

Announcement bar with link to latest major version release notes

What would you like to be able to do?

Users of Renovate frequently get confused and open issues/discussions to report "bugs" that are actually intended behavior from a breaking major release of Renovate.

I think we can reduce instances of readers getting confused by mentioning on our Docs homepage what our latest major release is, and to give them a link to read the release notes.

Did you already have any implementation ideas?

Material for MkDocs allows you to override ¹ the defaults with a custom overrides folder, where you can put a main.html file where you use a templating language to add your own custom HTML.

So we can use these features to add a announcement bar. ²

Unfortunately, we cannot let our readers "mark the announcement bar as read" ³ as that's a feature for people who sponsor Material for MkDocs, which costs $10 a month.
This means that the announcement bar stays visible when you visit a anchor link that takes you to the top of any page. The announcement bar will disappear when scrolling down though.

Proof of concept:

Proof of concept branch: https://github.com/HonkingGoose/renovatebot.github.io/tree/announcement-bar-poc

Screenshot:

Sidebar should be open for module details pages.

What browser are you using?

Not relevant

Describe the bug

if we open a module sub page, like npm manager, the sidebar is closed, it should be open instead.

Steps to reproduce
goto https://docs.renovatebot.com/modules/manager/npm/ and see closed sidebar

Additional context

Deploy our GitHub Pages site directly from our repository with GitHub Actions

Describe the proposed change(s).

We can drop the gh-pages branch, and publish directly from our main branch instead.

We probably need to change our GitHub Action files to get this working. I don't know enough about this. So I'll let @viceice do it for me. 😉

GitHub blog, GitHub Pages: Custom GitHub Actions Workflows (beta)

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error: expecting String near },

Merge confidence image hosted on GitHub not rendering in published docs

What browser are you using?

Firefox

Other browser name

No response

Describe the bug

I added a screenshot to the readme.md file for the "Merge Confidence" docs. You can see the screenshot when you view the readme.md on GitHub, but you can't see the screenshot on the published page.

The alt text "Renovate PR with Merge Confidence badges" is visible on the published page though, and it's in an <img> element, the src= property points to the correct place as well. So at least something is rendering... 🙈

Steps to reproduce

View the readme.md source file on GitHub -> image present.
Now view the published page Renovate docs, Merge Confidence -> image missing.

Additional context

View the Renovate docs, pinning dependencies and lock files, the images are working properly there.

The images that work are in the main Renovate repo under docs/usage/assets/images.

I'm not sure why it works when images are under docs/usage/assets/images and it breaks when I link to an external image on GitHub.

fix: generate datasources

I'm not entirely sure whether this ticket is supposed to be here or in renovate, but think here obvs.

The datasources page should include an auto-generated list of supported datasources but is empty.
https://docs.renovatebot.com/modules/datasource/#supported-datasources

I saw this was autogenerated in docs/usage/modules/datasource.md.

<!-- Autogenerate in https://github.com/renovatebot/renovatebot.github.io -->
<!-- Autogenerate end -->

I think this repository might be missing a function similar to generateManagers but then for generateDatasources.

Use Docusaurus

Hello,

I read Renovate's documentation through Docusaurus and I finally understood the configurations 😅. (Or maybe was it because it was the second time I read it 🥱).

https://github.com/ctison/renovate-doc -> https://renovate-doc.vercel.app

Using Docusaurus v2 would also allow to easily integrate Algolia (free plan for open source) (cf. https://v2.docusaurus.io/docs/search).

Are you interested I fix things and open a PR ?

Use admonitions instead of bolded text

What would you like to be able to do?

Our documentation Markdown highlights important things like this:

**Note:** thing to note.
**Warning:** thing to warn about.

The bolded parts stand out, but I think we can do better.
I'd like us to use admonition blocks. ¹

To make an admonition in the Markdown you use !!! then the type ² of admonition, and you use 4 spaces to indent the body text of the admonition. ³ Like this:

Shareable config presets can only be used with the JSON format, other formats are not supported.

!!! warning
    `default.json` is intended for use with presets only!

!!! warning
    Do not use a `renovate.json` file as a preset.

!!! info
    We've deprecated the use of a `renovate.json` file for presets as this can cause issues if the repository configuration uses a `renovate.json` file as well.

Did you already have any implementation ideas?

Yup, already made a proof of concept: https://github.com/HonkingGoose/renovatebot.github.io/tree/admonition-poc

You'll need to edit the docs/config-presets.md file after installing the dependencies, and then run mkdocs serve to preview the changes.

Screenshot:

Side by side comparison, left uses the default Material for MkDocs admonitions, the right is our current published site.

Renovate bot automerges PRs for git submodule `renovatebot/renovate` with failing build

Describe the proposed change(s).

Renovate bot automerges PRs which have a failing test, for example:

#178

We should update out branch protection rules for the main branch, so that it checks if the build passes.

Enable image captions

Describe the proposed change(s).

Material for MkDocs supports "image captions". ¹ When you use a image caption, the text for the image is centered below the image. This looks nicer than what we have now.

Example of using image captions:

<figure markdown>
  ![Image title](https://dummyimage.com/600x400/){ width="300" }
  <figcaption>Image caption</figcaption>
</figure>

To actually use the captions, we need to edit our Markdown files in the main renovatebot/renovate repository.

Todo:

enable the relevant extensions
override the docs/ file manually in the local preview
run make serve
check if it displays properly
check if other things keep working
open PR on docs site to enable the feature
open PR on renovatebot/renovate to fix the Swissquote article and the articles in "Deep dives" with images

Material for MkDocs manual, images ↩

Index page: Link to npm.js results in 404 not found for `renovate` package

What browser are you using?

Firefox.

Describe the bug

Link to our renovate package on NPM results in a 404 not found from npm.js

Steps to reproduce

Go to https://docs.renovatebot.com/
Click on link with text an Open Source npm package
See npm.js not found, with picture of a wombat.

Additional context

Source file for the index page is: https://github.com/renovatebot/renovatebot.github.io/blob/build/src/index.md

Setup and use `lint-staged` in development and in CI runs

What would you like to be able to do?

@viceice wanted me to install/configure lint-staged, but I don't know how I should set it up. 🙈

Did you already have any implementation ideas?

Let @viceice do it. 😉

Document `mkdocs.yml` configuration options in the config file

What would you like to be able to do?

The mkdocs.yml file has a lot of custom Material for MkDocs config options now.
It's hard to remember what each of these options do.

As @viceice said:

I'm pretty sure I don't remember these settings in a few months. 😅

Did you already have any implementation ideas?

Configuration documentation should go with the configuration file itself, so you don't have to search where the options are documented.

The goals are:

Have a short explanation besides each config item
Link to upstream docs
Remain readable when browsing the config

Create new sidebar section for user stories

Describe the proposed change(s).

Todo:

Wait until PR renovatebot/renovate#16809 is merged
Wait until Renovate has updated the Git submodule with the contents of that PR
Create a section for User Stories in the nav section of the mkdocs.yml config file
Check sidebar works with make build && make serve
Open PR

	if [ -z "$SKIP_BUILD" ]; then
	yarn install --frozen-lockfile
	yarn build:docs
	fi

	"scripts": {
	"prepare": "husky install",
	"prettier": "prettier --check --ignore-unknown \"*/.*\"",
	"prettier-fix": "prettier --write --ignore-unknown \"*/.*\""
	},

	- name: Cache Yarn packages
	uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed # renovate: tag=v2.1.7
	with:
	path: ${{ steps.init.outputs.yarn_cache }}
	key: ${{ runner.os }}-yarn_cache-${{ hashFiles('**/yarn.lock') }}
	restore-keys: \|
	${{ runner.os }}-yarn_cache-

	- name: Cache pip packages
	uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed # renovate: tag=v2.1.7
	with:
	path: ${{ steps.init.outputs.pip_cache }}
	key: ${{ runner.os }}-${{ env.python-version }}-pip-${{ hashFiles('**/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-${{ env.python-version }}-pip-

	printf -- '---\ntitle: Merge Confidence\ndescription: Node versions support in Renovate\n---\n\n' > docs/merge-confidence.md
	curl -sSLf https://raw.githubusercontent.com/whitesource/merge-confidence/main/README.md >> docs/merge-confidence.md

renovatebot / renovatebot.github.io Goto Github PK

renovatebot.github.io's Introduction

docs.renovatebot.com

Contributing

Security / Disclosure

renovatebot.github.io's People

Contributors

Stargazers

Watchers

Forkers

renovatebot.github.io's Issues

Pending Approval

Awaiting Schedule

Pending Status Checks

Detected dependencies

What would you like to be able to do?

Did you already have any implementation ideas?

Do you want to write this feature yourself?

Tasks

Describe the proposed change(s).

Describe the proposed change(s).

Footnotes

Footnotes

Which Renovate are you using?

Which platform are you using?

What would you like to do?

Footnotes

What would you like to be able to do?

Did you already have any implementation ideas?

Do you want to write this feature yourself?

Footnotes

How are you running Renovate?

If you're self-hosting Renovate, tell us what version of Renovate you run.

Please select which platform you are using if self-hosting.

If you're self-hosting Renovate, tell us what version of the platform you run.

Was this something which used to work for you, and then stopped?

Describe the bug

Relevant debug logs

Have you created a minimal reproduction repository?

Describe the proposed change(s).

Footnotes

Footnotes

Describe the proposed change(s).

What browser are you using?

Other browser name

Describe the bug

Steps to reproduce

Additional context

Footnotes

Describe the proposed change(s).

Describe the proposed change(s).

Footnotes

Describe the proposed change(s).

Recommend Projects

Recommend Topics

Recommend Org