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

https://github.com/pxpm/github-tag-action


https://github.com/pxpm/github-tag-action

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Create a GitHub Action Using TypeScript

[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)
[![Check dist/](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
[![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)

### This package is an updated version of https://github.com/tvdias/github-tagger
Code was literally copied from that package and pasted here using an updated version of the action boilerplate.
Thanks to all the people who also contributed over that other repo: https://github.com/tvdias/github-tagger/graphs/contributors

Tags the commit with a given text

Getting Started
To use, create a workflow (eg: .github/workflows/label.yml see Creating a Workflow file) and add a step like 'Tag commit' on the below sample. A token will be needed so the workflow can make calls to GitHub's rest API.

```yaml
name: "My workflow"
steps:
- name: Tag commit
uses: pxpm/[email protected]
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
tag: "my_tag"
```

Alternatively you can add a commit sha to override the default:
```yaml
steps:
- name: Tag commit
uses: pxpm/[email protected]
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
tag: "my_tag"
commit-sha: abc123efgesd
```