Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Commit

Permalink
fix workflow and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
marc-aurele-besner committed Apr 3, 2022
1 parent 54a1f83 commit b442753
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 24 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/package.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: NPM Package Update

on:
release:
types: [created]

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
- uses: actions/checkout@v2
- name: Setup Node v16
- uses: actions/setup-node@v3
with:
node-version: 16
- name: NPM Clean Install
run: npm ci

publish-npm:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
registry-url: https://registry.npmjs.org/
- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}

publish-gpr:
needs: build
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout
- uses: actions/checkout@v3
- name: Setup Node v16
- uses: actions/setup-node@v3
with:
node-version: 16
registry-url: https://npm.pkg.github.com/
- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
7 changes: 6 additions & 1 deletion .github/workflows/prettier.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,14 @@ jobs:

steps:
- name: Checkout
- uses: actions/checkout@v2with:
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
fetch-depth: 0
- name: Setup Node v16
- uses: actions/setup-node@v3
with:
node-version: 16
- name: Prettify code
uses: creyD/[email protected]
with:
Expand Down
7 changes: 6 additions & 1 deletion .github/workflows/tslint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,14 @@ jobs:
timeout-minutes: 2
steps:
- name: Checkout
- uses: actions/checkout@v2with:
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
fetch-depth: 0
- name: Setup Node v16
- uses: actions/setup-node@v3
with:
node-version: 16
- name: NPM Clean Install
run: npm ci
- name: TSLint
Expand Down
28 changes: 7 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,23 @@
# 👷 hardhat-awesome-cli
Hardhat made awesome with a flexible CLI to help run test, deploy and more.

# This package is not yet published on npmjs, for now

## 1. Clone repo
## 1. Install this package
With NPM
```commandline
git clone https://github.com/marc-aurele-besner/hardhat-awesome-cli.git
npm install hardhat-awesome-cli
```

## 2. Move in directory
```commandline
cd hardhat-awesome-cli
```

## 3. Create a NPM symbolic link
```commandline
npm link
```

## 4. NPM Link in the Hardhat project of your choice

Inside the root of the Hardhat project of your choice
Or with Yarn
```commandline
npm link hardhat-awesome-cli
yarn add hardhat-awesome-cli
```

## 5. Import/Require this package in your hardhat.config.js/.ts
## 1. Import/Require this package in your hardhat.config.js/.ts

Inside inside hardhat.config.js
```
require("hardhat-awesome-cli");
```
or inside hardhat.config.ts
or inside hardhat.config.ts (Typescript)
```
import hardhatAwesomeCli from 'hardhat-awesome-cli'
```
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"repository": "https://github.com/marc-aurele-besner/hardhat-easy-cli.git",
"author": "Marc-Aurele Besner <[email protected]>",
"license": "MIT",
"private": true,
"main": "dist/index.js",
"bin": {
"hardhat-easy-cli": "./src/index-cli.ts"
Expand Down

0 comments on commit b442753

Please sign in to comment.