https://github.com/ambersun1234/hardhat-test-action
Simple wrapper of hardhat test to GitHub Action
https://github.com/ambersun1234/hardhat-test-action
cicd githubactions hardhat solidity typescript
Last synced: 3 months ago
JSON representation
Simple wrapper of hardhat test to GitHub Action
- Host: GitHub
- URL: https://github.com/ambersun1234/hardhat-test-action
- Owner: ambersun1234
- License: mit
- Created: 2023-04-02T13:17:11.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-02-07T09:50:15.000Z (5 months ago)
- Last Synced: 2026-02-10T23:57:59.872Z (5 months ago)
- Topics: cicd, githubactions, hardhat, solidity, typescript
- Language: TypeScript
- Homepage:
- Size: 639 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hardhat Test Action
Simple wrapper of hardhat test for GitHub Action
## Introduction
This action aims to run on top of hardhat project, make sure you're using hardhat in your project\
Currently, we support 2 package manager(`yarn` and `npm`)\
By specifying `network` option in your workflow, this project can run on either `local hardhat network` or `testnet`\
One thing to note is that when you choose to run with testnet, since we're actually integrating with real blockchain, you need to provide an account with some amount of ETH based on your test case usage, you can provide your account via [GitHub Secrets](https://github.com/Azure/actions-workflow-samples/blob/master/assets/create-secrets-for-GitHub-workflows.md)
## How to use
Create a workflow file under `.github/workflows`, and name it as for example `test.yaml` and fill with following content
```yaml
name: unit-test
on: [push]
jobs:
test:
runs-on: ubuntu-latest
name: Hardhat unit test
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Environment
uses: actions/setup-node@v3
- name: Test
uses: ambersun1234/hardhat-test-action@v1
with:
network: hardhat
```
or
```yaml
name: unit-test
on: [push]
jobs:
test:
runs-on: ubuntu-latest
name: Hardhat unit test
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Environment
uses: actions/setup-node@v3
- name: Test
uses: ambersun1234/hardhat-test-action@v1
with:
network: goerli
private_key: ${{ secrets.PRIVATE_KEY }}
rpc_url: ${{ secrets.RPC_URL }}
```
## Secrets
In order for this action to work properly, you may need to specify `repository secrets`
1. `PRIVATE_KEY`
+ Your private key without `0x`
2. `RPC_URL`
+ RPC url endpoint, e.g. `https://eth-sepolia.g.alchemy.com/v2/xxxxxxxxxxxxxx`
Note that secrets are `case sensitive`, be sure to create secrets with all upper case
> You can find more information on [Encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)
## Note
To align environment variable with your hardhat project,\
please check your variable declaration match the following convention or not\
We'll use only 2 categories of variable
+ private key :arrow_right: defined as `PRIVATE_KEY`
+ rpc url :arrow_right: based on different test network, will have these structure `{NETWORK}_RPC_URL`, where `NETWORK` is the upper case of network name(e.g. `GOERLI`, `SEPOLIA`)
These environment variable needs to be consistent with data in
+ `hardhat.config.ts`
+ `.env`
## Example
You can find a complete example of how to use this action at [github.com/ambersun1234/nft](https://github.com/ambersun1234/nft)
## Build
```
$ yarn install
$ yarn webpack
```
## License
This project is licensed under MIT license - see the [LICENSE](./LICENSE) file for more detail