|
1 | | -# molt-action |
| 1 | +# 🦕 molt-action |
| 2 | + |
| 3 | +> [!WARNING]\ |
| 4 | +> Not released yet. You may try the `v1-rc` tag, but it is not guaranteed to |
| 5 | +> work. |
| 6 | +
|
| 7 | +A GitHub Action to update dependencies in Deno projects with |
| 8 | +[molt](https://github.com/hasundue/molt). |
| 9 | + |
| 10 | +## Example |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +## Usage |
| 15 | + |
| 16 | +```yaml |
| 17 | +runs-on: ubuntu-latest |
| 18 | + |
| 19 | +steps: |
| 20 | + - uses: actions/checkout@v4 |
| 21 | + |
| 22 | + - uses: hasundue/molt-action@v1-rc |
| 23 | + with: |
| 24 | + # optional inputs |
| 25 | +``` |
| 26 | + |
| 27 | +### Inputs |
| 28 | + |
| 29 | +All inputs are **optional**. If not set, sensible defaults will be used. Many of |
| 30 | +them are inherited from |
| 31 | +[peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) |
| 32 | +and passed through to it. |
| 33 | + |
| 34 | +| Name | Description | Default | |
| 35 | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | |
| 36 | +| `author` | Author of the pull request in the format of `Display Name <email@adress.com>`. | `${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>` | |
| 37 | +| `base` | Base branch to create the pull request against. | The branch checked out in the workflow | |
| 38 | +| `branch` | Head branch to create the pull request from. | `molt-action` | |
| 39 | +| `commit` | Whether to commit changes locally. | `true` | |
| 40 | +| `commit-prefix` | Prefix for commit messages. | `chore:` | |
| 41 | +| `committer` | Name of the committer in the format of `Display Name <email@address.com>` | `github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>` | |
| 42 | +| `draft` | Whether to create a draft pull request. | `false` | |
| 43 | +| `labels` | Comma or newline-separated list of labels to add to the pull request. | `dependencies` | |
| 44 | +| `pull-request` | Whether to create a pull request. | `true` | |
| 45 | +| `resolve-imports` | Resolve local imports to find dependencies recursively. | `false` | |
| 46 | +| `root` | Root directory of the relevant source files. | The shallowest directory containing `deno.json` or `deno.jsonc` if available, otherwise the repository root | |
| 47 | +| `source` | Glob patterns to match source files. | `deno.json{,c}` if available with imports, otherwise `**/*.ts` | |
| 48 | +| `token` | GitHub token with permissions `contents: write` and `pull-requests: write` or a repo scoped personal access token (PAT). | `${{ secrets.GITHUB_TOKEN }}` | |
0 commit comments