An open API service indexing awesome lists of open source software.

https://github.com/hasundue/molt-action

GitHub Action to update dependencies in Deno projects with hasundue/molt
https://github.com/hasundue/molt-action

deno dependencies github-actions

Last synced: 12 months ago
JSON representation

GitHub Action to update dependencies in Deno projects with hasundue/molt

Awesome Lists containing this project

README

          

# 🦕 molt-action

A GitHub Action to create a pull request to update dependencies in a Deno
project with [molt](https://github.com/hasundue/molt). See
[Pull requests](https://github.com/hasundue/molt-action/pulls) for an example.

## Usage

```yaml
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: hasundue/molt-action@v1
with:
# optional inputs
```

### Inputs

All inputs are **optional**. If not set, sensible defaults will be used. Many of
them are inherited from
[peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request)
and passed through to it.

| Name | Description | Default |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| `author` | Author of the pull request in the format of `Display Name `. | `${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>` |
| `base` | Base branch to create the pull request against. | The branch checked out in the workflow |
| `branch` | Head branch to create the pull request from. | `molt-action` |
| `commit` | Whether to commit changes locally. | `true` |
| `commit-prefix` | Prefix for commit messages. | `chore:` |
| `committer` | Name of the committer in the format of `Display Name ` | `github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>` |
| `config` | Relative path to the configuration file including imports from the root directory. Ignored if `root` is not given. Set to `false` to disable auto discovery. | `deno.json` or `deno.jsonc` if available |
| `draft` | Whether to create a draft pull request. | `false` |
| `labels` | Comma or newline-separated list of labels to add to the pull request. | `dependencies` |
| `lock` | Relative path to the lock file to update from the root directory. Ignored if `root` is not given. Set to `false` to disable auto discovery. | `deno.lock` if available |
| `pull-request` | Whether to create a pull request. | `true` |
| `root` | Root directory of the relevant source files. | The shallowest directory containing `deno.json` or `deno.jsonc` if available, otherwise the repository root |
| `source` | Source files to update dependencies in, specified as glob patterns. | If a Deno configuration file with imports is specified or found, this defaults to nothing. Otherwise, it defaults to `**/*.ts`. |
| `exclude` | Files to exclude from dependency updates, specified as glob patterns. If a directory is specified, all files under it are excluded. | `[]` |
| `token` | GitHub token with permissions `contents: write` and `pull-requests: write` or a repo scoped personal access token (PAT). | `${{ secrets.GITHUB_TOKEN }}` |
| `write` | Whether to write changes to disk. Forced to `true` if `commit` or `pull-request` is `true`. | `true` |

### Outputs

| Name | Description |
| -------------- | --------------------------------------------------------- |
| `dependencies` | A JSON list of updated dependencies, or an empty string. |
| `files` | A list of updated files. |
| `report` | A detailed report of the changes made in Markdown format. |
| `summary` | A summary of the changes made. |