generated from actions/typescript-action
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,126 +1,46 @@ | ||
| # CodSpeed Action | ||
|
|
||
| Github Actions for running CodSpeed in the CI. | ||
|
|
||
| # Usage | ||
|
|
||
| ```yaml | ||
| - uses: actions/checkout@v1 | ||
| - uses: CodSpeedHQ/action@v1 | ||
| with: | ||
| # Repository name with owner. For example, actions/checkout | ||
| # Default: ${{ github.repository }} | ||
| repository: "" | ||
|
|
||
| # The branch, tag or SHA to checkout. When checking out the repository that | ||
| # triggered a workflow, this defaults to the reference or SHA for that event. | ||
| # Otherwise, uses the default branch. | ||
| ref: "" | ||
| ``` | ||
| # Examples | ||
| ## With pytest | ||
| # Create a JavaScript Action using TypeScript | ||
| Use this template to bootstrap the creation of a TypeScript action.:rocket: | ||
| This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. | ||
| If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) | ||
| ## Create an action from this template | ||
| Click the `Use this Template` and provide the new repo details for your action | ||
| # [REQUIRED] the CodSpeed upload token: can be found at https://codspeed.com/settings | ||
| # You can then use the token as a secret in your repository | ||
| token: ${{ secrets.CODSPEED_TOKEN }} | ||
|
|
||
| ## Code in Main | ||
| # [REQUIRED] The command used to run your codspeed benchmarks | ||
| # Here with pytest: | ||
| run: pytest tests/ --benchmark | ||
|
|
||
| > 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 | ||
| # [OPTIONAL]: A custom upload url, if you are using a self-hosted CodSpeed instance | ||
| upload_url: "" | ||
| ``` | ||
| 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. | ||
| # Example workflows running CodSpeed | ||
| Update the action.yml with your name, description, inputs and outputs 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. | ||
|
|
||
| ```javascript | ||
| import * as core from '@actions/core'; | ||
| ... | ||
| async function run() { | ||
| try { | ||
| ... | ||
| } | ||
| catch (error) { | ||
| core.setFailed(error.message); | ||
| } | ||
| } | ||
| run() | ||
| ``` | ||
|
|
||
| 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)) | ||
| ## With pytest | ||
| ```yaml | ||
| uses: ./ | ||
| with: | ||
| milliseconds: 1000 | ||
| name: benchmarks | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - "master" | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| benchmarks: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-python@v3 | ||
| - run: pip install -r requirements.txt | ||
| - uses: CodSpeedHQ/action-@v1 | ||
| with: | ||
| token: ${{ secrets.CODSPEED_TOKEN }} | ||
| run: pytest tests/ --benchmark | ||
| ``` | ||
|
|
||
| See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket: | ||
|
|
||
| ## Usage: | ||
|
|
||
| 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 |