Skip to content

Commit

Permalink
ci: adds more CI validations, introduces semantic release (#74)
Browse files Browse the repository at this point in the history
Also:
- Uses semantic release
- Adds checks on before commit and in CI: eslint and commit lint
  • Loading branch information
ygrishajev committed Apr 17, 2024
1 parent 7f11ac8 commit e20e648
Show file tree
Hide file tree
Showing 28 changed files with 12,126 additions and 4,792 deletions.
18 changes: 18 additions & 0 deletions .commitlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"extends": [
"@commitlint/config-conventional"
],
"rules": {
"scope-enum": [
2,
"always",
[
"certificates",
"network",
"wallet",
"api",
"stargate"
]
]
}
}
13 changes: 11 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@
},
"plugins": ["@typescript-eslint"],
"rules": {
"@typescript-eslint/no-unused-vars": ["error", { "ignoreRestSiblings": true }]
}
"@typescript-eslint/no-unused-vars": ["error", { "ignoreRestSiblings": true }],
"@typescript-eslint/no-explicit-any": "warn"
},
"overrides": [
{
"files": ["*.js"],
"rules": {
"@typescript-eslint/no-var-requires": "off"
}
}
]
}
34 changes: 34 additions & 0 deletions .github/actions/setup-node/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: 'Setup Node.js and Cache Dependencies'
description: 'Checks out code, sets up Node.js, installs dependencies, and handles caching'

inputs:
node-version:
description: 'Node.js version to setup'
required: true
default: '18.0.0'

runs:
using: 'composite'
steps:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ inputs.node-version }}

- name: Restore node_modules cache
id: deps-cache
uses: martijnhols/actions-cache/restore@v3
with:
path: node_modules
key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}

- name: Install dependencies
run: npm install
if: steps.deps-cache.outputs.cache-hit != 'true'

- name: Cache node modules
if: steps.deps-cache.outputs.cache-hit != 'true'
uses: martijnhols/actions-cache/save@v3
with:
path: node_modules
key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}
30 changes: 0 additions & 30 deletions .github/workflows/build.yml

This file was deleted.

21 changes: 21 additions & 0 deletions .github/workflows/code-style-reusable.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Code Style

on:
- workflow_call

env:
HUSKY: 0

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js and Cache Dependencies
uses: ./.github/actions/setup-node

- name: Lint
run: npm run lint
14 changes: 14 additions & 0 deletions .github/workflows/code-style.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Code Style

on:
- pull_request

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
code-style:
name: Code Style
uses: ./.github/workflows/code-style-reusable.yml
secrets: inherit
19 changes: 19 additions & 0 deletions .github/workflows/commit-lint-reusable.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Commit Lint

on:
- workflow_call

env:
HUSKY: 0

jobs:
commit-lint:
name: Validate PR commits with commitlint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Validate PR commits with commitlint
uses: wagoid/commitlint-github-action@v6

14 changes: 14 additions & 0 deletions .github/workflows/commit-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Commit Lint

on:
- pull_request

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
commit-lint:
name: Commit Lint
uses: ./.github/workflows/commit-lint-reusable.yml
secrets: inherit
36 changes: 0 additions & 36 deletions .github/workflows/npm.yml

This file was deleted.

67 changes: 67 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Release from Master on Push

on:
push:
branches:
- main

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

env:
HUSKY: 0

jobs:
commit-lint:
name: Commit Lint
uses: ./.github/workflows/commit-lint-reusable.yml
secrets: inherit

lint:
name: Lint and report coverage
uses: ./.github/workflows/code-style-reusable.yml
secrets: inherit

test:
name: Run tests
uses: ./.github/workflows/test-reusable.yml
secrets: inherit

release:
name: Build and release npm package
needs: [commit-lint, lint, test]
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
id: setup_node
uses: actions/setup-node@v4
with:
node-version: 18.0.0

- name: Restore node_modules cache
id: deps-cache
uses: martijnhols/actions-cache/restore@v3
with:
path: node_modules
key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}

- name: Install dependencies
if: steps.deps-cache.outputs.cache-hit != 'true'
run: npm install

- name: Release npm package
uses: cycjimmy/semantic-release-action@v4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Cache node modules
if: steps.deps-cache.outputs.cache-hit != 'true'
uses: martijnhols/actions-cache/save@v3
with:
path: node_modules
key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}
48 changes: 48 additions & 0 deletions .github/workflows/test-reusable.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Test

on:
- workflow_call

env:
HUSKY: 0

jobs:
test:
name: Test and report coverage
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
id: setup_node
uses: actions/setup-node@v4
with:
node-version: 18.0.0

- name: Restore node_modules cache
id: deps-cache
uses: martijnhols/actions-cache/restore@v3
with:
path: node_modules
key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}

- name: Install dependencies
if: steps.deps-cache.outputs.cache-hit != 'true'
run: npm install

- name: Test
run: npm run test:cov

- name: Upload Test Coverage
uses: codecov/codecov-action@v4
with:
files: ./ts/coverage
token: ${{ secrets.CODECOV_TOKEN }}

- name: Cache node modules
if: steps.deps-cache.outputs.cache-hit != 'true'
uses: martijnhols/actions-cache/save@v3
with:
path: node_modules
key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}
14 changes: 14 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Test

on:
- pull_request

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
test:
name: Test
uses: ./.github/workflows/test-reusable.yml
secrets: inherit
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ umd/

# Coverage directory
.nyc_output/
coverage

# Log files
yarn-error.log
Expand Down
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx --no -- commitlint --edit $1
31 changes: 31 additions & 0 deletions .releaserc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
[
"@semantic-release/changelog",
{
"changelogFile": "CHANGELOG.md"
}
],
[
"@semantic-release/npm",
{
"tarballDir": "package"
}
],
[
"@semantic-release/github",
{
"assets": "package/*.tgz"
}
],
"@semantic-release/git"
],
"branches": [
{
"name": "main"
}
],
"preset": "conventionalcommits"
}
Loading

0 comments on commit e20e648

Please sign in to comment.