Skip to content

Commit

Permalink
feat: github actions
Browse files Browse the repository at this point in the history
* Add lintstaged and prettier
  • Loading branch information
ryscheng committed Oct 17, 2024
1 parent 50b20e4 commit aa06e0a
Show file tree
Hide file tree
Showing 10 changed files with 1,258 additions and 11 deletions.
68 changes: 68 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
module.exports = {
env: {
browser: true,
es2021: true,
node: true,
},
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:react/recommended",
"prettier",
],
ignorePatterns: [
"**/vendor/*.js",
"vendor/**/*.js",
"**/jest.config.ts",
"**/test.only/**",
"**/utilities/**",
"**/.eslintrc.js",
"**/postcss.config.js",
//"**/next.config.js",
//"**/tailwind.config.js",
//"**/.env",
],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaFeatures: {
jsx: true,
},
ecmaVersion: "latest",
sourceType: "module",
tsconfigRootDir: __dirname,
project: "./tsconfig.json",
},
plugins: ["@typescript-eslint", "react"],
settings: {
react: {
version: "detect",
},
},
rules: {
"@typescript-eslint/no-misused-promises": "error",
"@typescript-eslint/no-floating-promises": "error",
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-unused-expressions": "off",
"@typescript-eslint/no-unused-vars": [
"warn",
{
argsIgnorePattern: "^_",
},
],
"no-restricted-properties": [
"error",
{
object: "console",
property: "error",
message: "Please use the logger instead.",
},
],
"no-restricted-globals": [
"error",
{
name: "prompt",
message: "Please use a React modal instead.",
},
],
},
};
92 changes: 92 additions & 0 deletions .github/workflows/ci-default.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# NOTE: This name appears in GitHub's Checks API and in workflow's status badge.
name: ci-default
env:
# CI variables
DOCKER_PLATFORM: "amd64"
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
# Docs variables
DOCS_URL: "https://docs.kariba.network"
DOCS_ALGOLIA_APP_ID: "test"
DOCS_ALGOLIA_API_KEY: "test"
DOCS_ALGOLIA_INDEX: "test"
DOCS_SEGMENT_WRITE_KEY: "test"

# Trigger the workflow when:
on:
# A push occurs to one of the matched branches.
push:
branches:
- main
# Or when a pull request event occurs for a pull request against one of the
# matched branches.
pull_request:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
merge_group:

# Cancel in progress jobs on new pushes.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
lint-and-test:
# NOTE: This name appears in GitHub's Checks API.
name: test
environment: testing
runs-on: ubuntu-latest
strategy:
matrix:
component: ["node"]
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
# Check out pull request's HEAD commit instead of the merge commit to
# prevent gitlint from failing due to too long commit message titles,
# e.g. "Merge 3e621938d65caaa67f8e35d145335d889d470fc8 into 19a39b2f66cd7a165082d1486b2f1eb36ec2354a".
ref: ${{ github.event.pull_request.head.sha }}
# Fetch all history so gitlint can check the relevant commits.
fetch-depth: "0"

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 9.6.0
run_install: |
- recursive: true
args: [--frozen-lockfile, --strict-peer-dependencies]
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "20.x"
cache: "pnpm"

- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
with:
version: nightly-87bc53fc6c874bd4c92d97ed180b949e3a36d78c
if: ${{ matrix.component == 'node' }}

# Automatically retry if the build fails
- name: Build (Node)
run: |
pnpm build
# Always run this step so that all linting errors can be seen at once.
if: ${{ matrix.component == 'node' }}

- name: Lint (Node)
run: |
pnpm lint
# Always run this step so that all linting errors can be seen at once.
if: ${{ always() && matrix.component == 'node' }}

- name: Test (Node)
run: |
pnpm test
# Always run this step so that all linting errors can be seen at once.
if: ${{ always() && matrix.component == 'node' }}
56 changes: 56 additions & 0 deletions .github/workflows/deploy-docusaurus-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# NOTE: This name appears in GitHub's Checks API and in workflow's status badge.
name: deploy-docusaurus-docs
env:
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
DOCS_URL: ${{ vars.DOCS_URL }}
DOCS_ALGOLIA_APP_ID: ${{ vars.DOCS_ALGOLIA_APP_ID }}
DOCS_ALGOLIA_API_KEY: ${{ vars.DOCS_ALGOLIA_API_KEY }}
DOCS_ALGOLIA_INDEX: ${{ vars.DOCS_ALGOLIA_INDEX }}
DOCS_SEGMENT_WRITE_KEY: ${{ vars.DOCS_SEGMENT_WRITE_KEY }}

# Trigger the workflow when:
on:
# A push occurs to one of the matched branches.
push:
branches:
- main
paths:
- apps/docs/**
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
build-deploy:
# NOTE: This name appears in GitHub's Checks API.
name: build-deploy
environment: deploy
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 1

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 9.6.0
run_install: |
- recursive: true
args: [--frozen-lockfile, --strict-peer-dependencies]
- name: Set up Node.js 20
uses: actions/setup-node@v4
with:
cache: "pnpm"
node-version: "20.x"

- name: Build
run: pnpm build:docs

- name: Publish
uses: cloudflare/wrangler-action@v3
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
workingDirectory: "apps/docs"
command: pages deploy build --project-name=docs-kariba-network
15 changes: 15 additions & 0 deletions .lintstagedrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"**/!(.eslintrc)*.{js,jsx,ts,tsx,sol}": [
"eslint --ignore-path .gitignore --max-warnings 0",
"prettier --ignore-path .gitignore --write",
"prettier --ignore-path .gitignore --log-level warn --check"
],
"**/*.{md,json}": [
"prettier --ignore-path .gitignore --write",
"prettier --ignore-path .gitignore --log-level warn --check"
],
"**/*.py": [
"poetry run ruff check --fix --force-exclude",
"pnpm pyright"
]
}
3 changes: 3 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"trailingComma": "all"
}
4 changes: 2 additions & 2 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "pnpm build:everything",
"build": "echo $DOCS_URL && pnpm build:everything",
"build:docs": "docusaurus build",
"build:everything": "pnpm plasmic:update && pnpm plasmic:sync && pnpm build:docs",
"swizzle": "docusaurus swizzle",
Expand All @@ -18,7 +18,7 @@
"lint": "pnpm lint:eslint && pnpm lint:prettier",
"lint:eslint": "eslint --max-warnings 0 .",
"lint:prettier": "prettier --ignore-path ../../.gitignore --ignore-path .gitignore --ignore-path .prettierignore --log-level warn --check **/*.{js,jsx,ts,tsx,sol,md,json}",
"plasmic:update": "pnpm update @plasmicapp/cli @plasmicapp/react-web",
"plasmic:update": "pnpm install && pnpm update @plasmicapp/cli @plasmicapp/react-web",
"plasmic:sync": "pnpm plasmic sync --yes --force"
},
"dependencies": {
Expand Down
2 changes: 2 additions & 0 deletions apps/docs/src/config.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import dotenv from "dotenv";
console.log(process.env);
const envPath = [__dirname, "../.env.local"].join("/");
dotenv.config();
dotenv.config({ path: envPath, override: true });
console.log(process.env);

/**
* Mark an environment as required for the build.
Expand Down
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@
"prepare": "husky install"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^8.9.0",
"eslint": "^9.12.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-react": "^7.37.1",
"husky": "^9.1.6",
"lint-staged": "^15.2.10",
"prettier": "^3.3.3",
Expand All @@ -43,6 +46,7 @@
"node": ">=18.x",
"pnpm": ">=8"
},
"packageManager": "[email protected]",
"dependencies": {
"pyright": "^1.1.385"
}
Expand Down
Loading

0 comments on commit aa06e0a

Please sign in to comment.