From cdc26401e561fc8ca1971512879f5aeb295e8941 Mon Sep 17 00:00:00 2001 From: Taiki Endo Date: Mon, 31 Jul 2023 22:32:04 +0900 Subject: [PATCH] Tweak development guide --- DEVELOPMENT.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index c6cc9771..06dc4189 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -2,13 +2,15 @@ ## Add support for new tool -(Example: [2ba826d](https://github.com/taiki-e/install-action/commit/2ba826d3ded42d6fa480b6bb82810d1282aa3460)) +(Example: [ffbd316](https://github.com/taiki-e/install-action/commit/ffbd316e0fe98cb460dae3a66cd2ef9deb398bb1)) -1\. Add base manifest to [`tools/codegen/base`](tools/codegen/base) directory. +1\. Add tool name to the table in ["Supported tools" section in `README.md`](https://github.com/taiki-e/install-action#supported-tools). + +2\. Add base manifest to [`tools/codegen/base`](tools/codegen/base) directory. See JSON files in `tools/codegen/base` directory for examples of the manifest. -2\. Generate manifest with the following command (replace `` with the tool name). +3\. Generate manifest with the following command (replace `` with the tool name). ```sh ./tools/manifest.sh @@ -21,8 +23,6 @@ See JSON files in `tools/codegen/base` directory for examples of the manifest. > GITHUB_TOKEN=$(gh auth status --show-token 2>&1 | sed -n 's/^.*Token: \(.*\)$/\1/p') ./tools/manifest.sh > ``` -3\. Add tool name to the table in ["Supported tools" section in `README.md`](https://github.com/taiki-e/install-action#supported-tools). - ## Troubleshooting If one of the CI builds fails due to a bin path or release asset_name, fix the problem in the base