0
0
mirror of https://github.com/renovatebot/renovate.git synced 2024-12-22 21:48:32 +00:00
renovatebot_renovate/lib/modules/datasource/hermit/readme.md
Yun Lai 9280430f4c
feat: add datasource for Hermit package manager (#16257)
* feat: add datasource for Hermit package manager

* fix: make hermit datasource use http.stream instead of http.get

* chore: inline small function and return null on error in hermit datasource

* fix: use regExp to extract owner and repo from registryUrl

* fix: use http from super & use error instead of debug on datasource error

* fix: fix type check failure for github-release test

* Update lib/modules/datasource/hermit/index.spec.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* Update lib/modules/datasource/hermit/index.spec.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* Update lib/modules/datasource/hermit/index.spec.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* Update lib/modules/datasource/hermit/index.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* fix: wrap JSON.parse to avoid breaking process, plus more comment onto the search manifest streaming process

* fix: add test to cover the invalid json case

* fix: change some logger.errors to logger.warn in hermit datasource, error will exit the whole process

* Update lib/modules/datasource/hermit/index.spec.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* Update lib/modules/datasource/hermit/index.spec.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* Update lib/modules/datasource/hermit/index.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* Update lib/modules/datasource/hermit/index.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* Update lib/modules/datasource/hermit/index.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* fix: use parseUrl and use hermit as GithubHttp id

* fix: added test to include HermitDatasource type in GITHUB_API_USING_HOST_TYPES

* fix: handle invalid url & achieve code coverage

* fix: move url parsing to parent function

* Update lib/modules/datasource/hermit/index.ts

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

* chore: clean up HermitDataSource class doc

* fix: getHermitSearchManifest cache key function should expect undefined

* fix: pass GetReleasesConfig into getHermitSearchManifest to get proper caching working

* Update lib/modules/datasource/hermit/readme.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update lib/modules/datasource/hermit/readme.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update lib/modules/datasource/hermit/readme.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update lib/modules/datasource/hermit/readme.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update lib/modules/datasource/hermit/readme.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* chore: fix json block in datasource readme.md

* Put packageRules example in step 4

* fix: fix lint error

* fix: pass parsedUrl into getHermitSearchManifest, add warning and simplifies type

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2022-07-15 09:57:05 +00:00

1002 B

By default Hermit looks up packages from the open source project https://github.com/cashapp/hermit-packages.

Hermit supports private packages. To get Renovate to find your private packages, follow these steps:

  1. perform hermit search --json with your private Hermit distribution and save the file to index.json

  2. make a GitHub release in your private packages repository named index with the asset index.json generated in step 1.

  3. setup a CI pipeline to repeat step 1 & 2 on new commits to the private packages repository.

  4. Add a package rule for the Hermit manager, so that Renovate knows where to find your private packages:

    {
      "packageRules": [
        {
          "matchManagers": ["hermit"],
          "defaultRegistryUrls": [
            "https://github.com/your/private-hermit-packages"
          ]
        }
      ]
    }