https://github.com/freckle/typescript-action-template
Template repository for a GitHub Action implemented in TypeScript
https://github.com/freckle/typescript-action-template
Last synced: 8 months ago
JSON representation
Template repository for a GitHub Action implemented in TypeScript
- Host: GitHub
- URL: https://github.com/freckle/typescript-action-template
- Owner: freckle
- License: mit
- Created: 2022-04-25T15:14:01.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T00:02:55.000Z (about 2 years ago)
- Last Synced: 2024-05-23T01:25:24.694Z (about 2 years ago)
- Language: TypeScript
- Size: 800 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# TypeScript Action Template
Our custom template repository for GitHub Actions implemented in TypeScript.
[Creating a repository from a template][docs].
[docs]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
**NOTE**: Be sure to look for strings like "TODO" or "Action name" and update
them accordingly.
## Usage
```yaml
- uses: freckle/TODO-action@v1
```
## Inputs and Outputs
See [action.yml](./action.yml) for a complete list of inputs and outputs.
## Permissions
This action requires the following permissions:
```yaml
permissions: {}
```
As the action uses the GitHub API, these should be updated to reflect the
minimal permissions required. These permissions may need to be manually set in
certain scenarios, such as workflows triggered by Dependabot PRs, which use a
read-only `GITHUB_TOKEN`.
## Versioning
Versioned tags will exist, such as `v1.0.0` and `v2.1.1`. Tags will also exist
for each major version, such as `v1` or `v2` and point to the newest version in
that series.
## Release
To trigger a release (and update the `@v{major}` tag), merge a commit to `main`
that follows [Conventional Commits][]. In short,
- `fix:` to trigger a patch release,
- `feat:` for minor, and
- `feat!:` and major
We don't enforce conventional commits generally (though you are free do so),
it's only required if you want to trigger release.
[conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/#summary
---
[LICENSE](./LICENSE)