From 7335e7f002da5df50609b42be06501621abbfc94 Mon Sep 17 00:00:00 2001 From: Kenichi Kamiya Date: Sat, 19 Nov 2022 04:02:33 +0900 Subject: [PATCH] Update documents https://github.com/kachick/renovate-config-asdf/pull/388#discussion_r1026728640 https://github.com/kachick/renovate-config-asdf/issues/378 https://github.com/renovatebot/renovate/pull/18987 --- CONTRIBUTING.md | 6 ++++++ README.md | 13 +++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f925bd2..b7a6ff4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,9 @@ +# Contributing + +We recommend to send PRs into [official asdf manager](https://github.com/renovatebot/renovate/tree/84bb830e00134bd32ff2cb5b94411fd6a080b4c4/lib/modules/manager/asdf). + +However when you would add new plugins into this repository from some reasons, this guide might help. + ## Setup environments ```console diff --git a/README.md b/README.md index 6161f099..c4f3fcdb 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,19 @@ [![Build Status - Regex](https://github.com/kachick/renovate-config-asdf/actions/workflows/ci-typescript.yml/badge.svg?branch=main)](https://github.com/kachick/renovate-config-asdf/actions/workflows/ci-typescript.yml?query=branch%3Amain) [![Build Status - Build Tools](https://github.com/kachick/renovate-config-asdf/actions/workflows/ci-crystal.yml/badge.svg?branch=main)](https://github.com/kachick/renovate-config-asdf/actions/workflows/ci-crystal.yml?query=branch%3Amain) -## Usage +## Overview [Renovate sharable config](https://docs.renovatebot.com/config-presets/) for [.tool-versions (asdf)](https://github.com/asdf-vm/asdf-plugins/tree/master/plugins). Since renovate version [34.25.0](https://github.com/renovatebot/renovate/pull/18612#issuecomment-1315123140), official asdf manager imported most plugins of this repository.\ -So you don't need to depend this config excepts hugo/gohugo.\ -This repository's hugo definition supports [extended hugo releases](https://github.com/gohugoio/hugo/blob/af23cdca9c9c230ffbffbab96f9600a78c76b75f/docs/content/en/troubleshooting/faq.md?plain=1#L50-L60). See the [issue](https://github.com/kachick/renovate-config-asdf/issues/294) for further detail.\ -You can pick some [plugins](./plugins) as below. +And it merged [extended hugo releases](https://github.com/gohugoio/hugo/blob/af23cdca9c9c230ffbffbab96f9600a78c76b75f/docs/content/en/troubleshooting/faq.md?plain=1#L50-L60) in following [34.28.0](https://github.com/renovatebot/renovate/pull/18987#issuecomment-1320388809). +So you don't need to depend this config now! + +(Below sections are historical. You can leave here.) + +## Usage + +In someday, I might add some definitions for my personal use again. Then they should be used as below. ```json {