mirror of
https://github.com/taiki-e/install-action.git
synced 2026-04-22 15:30:31 +00:00
Tweak development guide
This commit is contained in:
@@ -2,13 +2,15 @@
|
|||||||
|
|
||||||
## Add support for new tool
|
## 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.
|
See JSON files in `tools/codegen/base` directory for examples of the manifest.
|
||||||
|
|
||||||
2\. Generate manifest with the following command (replace `<tool>` with the tool name).
|
3\. Generate manifest with the following command (replace `<tool>` with the tool name).
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./tools/manifest.sh <tool>
|
./tools/manifest.sh <tool>
|
||||||
@@ -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 <tool>
|
> GITHUB_TOKEN=$(gh auth status --show-token 2>&1 | sed -n 's/^.*Token: \(.*\)$/\1/p') ./tools/manifest.sh <tool>
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
3\. Add tool name to the table in ["Supported tools" section in `README.md`](https://github.com/taiki-e/install-action#supported-tools).
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
If one of the CI builds fails due to a bin path or release asset_name, fix the problem in the base
|
If one of the CI builds fails due to a bin path or release asset_name, fix the problem in the base
|
||||||
|
|||||||
Reference in New Issue
Block a user