Example for GitHub Action Using TS is a custom GitHub Action designed to handle text processing, lists, and API requests efficiently using TypeScript. The action is configured using a TOML file.
- Text Processing: Perform find-and-replace operations on provided text.
- List Operations: Calculate word count, sum, and average for provided data.
- API Requests: Fetch data from APIs and extract specific fields.
- Configuration: Fully configurable via a TOML file.
| Name | Description | Required | Default |
|---|---|---|---|
config_path |
Path to the TOML configuration file | No | .github/configs/setup-custom-action-by-ts.toml |
| Name | Description |
|---|---|
processed_text |
The processed text after find and replace |
word_count |
The total number of words in the text |
sum |
The sum of the numbers |
average |
The average of the numbers |
response_field |
A specific field from the API response |
To use this GitHub Action in your workflow, you can define a step that utilizes it. Here's an example:
name: Example Workflow
on: [ push ]
jobs:
example-job:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run Example for GitHub Action Using TS
uses: pplmx/setup-custom-action-by-ts@main
You can also follow this.
To set up the project locally:
- Clone the repository
- Run
npm installto install dependencies - Use
npm run buildto compile TypeScript - Run tests with
npm test
For more detailed instructions, please refer to the Development Documentation.
This project is dual-licensed under either of the following licenses, at your option:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
For more details, see CONTRIBUTING.md.