Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
huacnlee committed Feb 27, 2024
1 parent 7f04dc8 commit 92e11bb
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Create a `release.yml` file in `.github/workflows` directory with the following
on:
push:
tags:
- "v*"
- 'v*'

jobs:
homebrew:
Expand All @@ -19,23 +19,34 @@ jobs:
steps:
- uses: huacnlee/zed-extension-action@v1
with:
extension-name: my_extension
extension-name: your-extension-name
# extension-path: extensions/${{ extension-name }}
push-to: your-name/extensions
env:
# the personal access token should have "repo" & "workflow" scopes
COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }}
```
## Inputs
| Name | Description | Required | Default |
| ---------------- | ------------------------------------------------------------ | -------- | -------------------------------- |
| `extension-name` | The name of your Zed extension. | `true` | - |
| `extension-path` | If you have a different path, you can set it. | `false` | `extensions/${ extension-name }` |
| `push-to` | The forked repository of the zed-industries/extensions repo. | `true` | - |

The `COMMITTER_TOKEN` is a personal access token with `repo` and `workflow` scopes. You can create one in your [GitHub settings](https://github.com/settings/tokens).

## How it works

When a new tag is pushed, the action will:

1. Check if the tag is a valid version number.
2. Create a Pull Request with the new version to [Zed Extensions](https://github.com/zed-industries/extensions) repository.
2. Create a Pull Request with the new version to [Zed Extensions](https://github.com/zed-industries/extensions/pulls) repository.
3. Merge the Pull Request if it's approved, then the extension version will released.

See example: https://github.com/zed-industries/extensions/pull/217

## License

MIT

0 comments on commit 92e11bb

Please sign in to comment.