Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prodyna/flutter-test-action
GitHub Action for `flutter test`
https://github.com/prodyna/flutter-test-action
action flutter github
Last synced: about 1 month ago
JSON representation
GitHub Action for `flutter test`
- Host: GitHub
- URL: https://github.com/prodyna/flutter-test-action
- Owner: PRODYNA
- License: mit
- Created: 2022-09-29T14:18:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T08:30:06.000Z (7 months ago)
- Last Synced: 2024-06-18T09:27:50.619Z (7 months ago)
- Topics: action, flutter, github
- Language: TypeScript
- Homepage:
- Size: 1.44 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# flutter-test-action
This action runs `flutter test` and attaches a [check run](https://docs.github.com/en/rest/checks/runs) to the current commit.
## Usage
```yaml
jobs:
test:
name: Test Runner
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Setup SDK
uses: subosito/flutter-action@v2
with:
flutter-version: "3.0"
cache: true
- uses: PRODYNA/flutter-test-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
project: ./app
```
## Code in Main
> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
Install the dependencies
```bash
npm install
```
Build the typescript and package it for distribution
```bash
npm run build && npm run package
```
Run the tests :heavy_check_mark:
```bash
$ npm test
PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
...
```
## Change action.yml
The action.yml defines the inputs and output for your action.
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
## Change the Code
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
## Publish to a distribution branch
Actions are run from GitHub repos so we will checkin the packed dist folder.
Then run [ncc](https://github.com/zeit/ncc) and push the results:
```bash
npm run package
git add dist
git commit -a -m "prod dependencies"
git push origin releases/v1
```
Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
Your action is now published! :rocket:
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
## Validate
You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
```yaml
uses: ./
with:
token: ${{ secrets.GITHUB_TOKEN }}
project: app
```
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
## Create a Tag
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action