https://github.com/zetavg/generate-build-results-md-action
https://github.com/zetavg/generate-build-results-md-action
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zetavg/generate-build-results-md-action
- Owner: zetavg
- License: mit
- Created: 2024-02-26T04:42:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-24T17:34:28.000Z (12 months ago)
- Last Synced: 2025-02-15T12:56:53.286Z (4 months ago)
- Language: TypeScript
- Size: 222 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Generate Build Results in Markdown
## Development
After you've cloned the repository to your local machine or codespace, you'll
need to perform some initial setup steps before you can develop your action.
> [!NOTE]
>
> You'll need to have a reasonably modern version of
> [Node.js](https://nodejs.org) handy (20.x or later should work!). If you are
> using a version manager like [`nodenv`](https://github.com/nodenv/nodenv) or
> [`nvm`](https://github.com/nvm-sh/nvm), this template has a `.node-version`
> file at the root of the repository that will be used to automatically switch
> to the correct version when you `cd` into the repository. Additionally, this
> `.node-version` file is used by GitHub Actions in any `actions/setup-node`
> actions.
1. :hammer_and_wrench: Install the dependencies
```bash
npm install
```
1. :building_construction: Package the TypeScript for distribution
```bash
npm run bundle
```
1. :white_check_mark: Run the tests
```bash
$ npm test
PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
...
```
### Before you commit
Run `npm run all` before committing.