Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wesleyscholl/github-action-base-ts
A Typescript GitHub Action Starter Repo 🚀 ▶️
https://github.com/wesleyscholl/github-action-base-ts
actions boilerplate boilerplate-template github github-actions jest prettier starter starter-project starter-template ts typescript workflows
Last synced: about 2 months ago
JSON representation
A Typescript GitHub Action Starter Repo 🚀 ▶️
- Host: GitHub
- URL: https://github.com/wesleyscholl/github-action-base-ts
- Owner: wesleyscholl
- License: mit
- Created: 2023-09-29T20:04:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-15T21:04:11.000Z (about 1 year ago)
- Last Synced: 2023-11-16T14:47:56.782Z (about 1 year ago)
- Topics: actions, boilerplate, boilerplate-template, github, github-actions, jest, prettier, starter, starter-project, starter-template, ts, typescript, workflows
- Language: TypeScript
- Homepage: https://github.com/wesleyscholl/github-action-base-ts
- Size: 167 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-action-base-ts
### A Typescript GitHub Action Starter Repo 🚀▶️
[](https://github.com/wesleyscholl/discussion-auto-responder/blob/main/src/__tests__/index.test.ts)   [](https://gist.github.com/wesleyscholl/10f0b77400703c4a65f38434106adf2d) [](https://github.com/marketplace/actions/discussion-auto-responder)   [](https://github.com/prettier/prettier) [](https://github.com/prettier/prettier)        [](https://raw.githubusercontent.com/wesleyscholl/discussion-auto-responder/main/LICENSE)
## About
GitHub Action Description.
## Usage
In your workflow, to use this github action add a step like this to your workflow:
```yaml
- name: Run github-action
uses: wesleyscholl/[email protected]
id: github-action
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" # Required/optional - Description
input1: "string" # Required/optional - Description
input2: 10 # Required/optional - Description
```
**Subscribing to GitHub events to kick off GitHub action workflows:**
```yaml
on:
discussion:
types: [created]
```
## Requirements
Description about requirements to run this GitHub Action.
Configure:
- Option 1
- Option 2
- Option 3
- More detailed configuration step.
## Inputs
| Name | Description | Requried? | Default |
| --- | --- | --- | --- |
| `GITHUB_TOKEN` | Ensure you create a PAT with `discussion: write` and `repo: write`, then add it as an github action secret in your repo. | **No** | `${{ secrets.GITHUB_TOKEN }}` |
| `comment_body` | The contents of the autoresponder comment in string format. | **No** | `"This comment was generated by the Discussion Autoresponder GitHub Action."` |
## Outputs
| Name | Description | How To Access |
| --- | --- | --- |
| `ghaVar1` | Description about output1. | `${{ steps..outputs.variable1}}` |
| `ghaVar1` | Description about output2. | `${{ steps..outputs.variable2 }}` |
#### Accessing Outputs
```yml
- name: Show Outputs
run: |
echo "variable1 = ${{ steps..outputs.variable1 }}"
echo "variable2 = ${{ steps..outputs.variable2 }}"
```
## Example
Example [workflow](https://github.com///.yaml)
## Configuration
*If you fork this repository, ensure you enable workflows in the workflows tab.
## Credits
- [Link1](https://google.com)
### Inspired by:
- [Link2](https://google.com)
- [Link3](https://google.com)