Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump Othent to 2.1.1 and configure CI pipeline #22

Merged
merged 4 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/actions/setup-environment-n-deps/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: ⚙️ Setup Environment and Dependencies
description: Checkout code, setup Node.js, setup PNPM, and install/restore dependencies.
runs:
# See https://docs.github.com/en/actions/sharing-automations/avoiding-duplication
using: composite

steps:
- name: ⚙️ Install PNPM
uses: pnpm/action-setup@v4
with:
version: 9
run_install: false

- name: ⚙️ Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: "pnpm"

- name: ⚙️ Get PNPM store directory
id: pnpm-cache
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT

- name: ⚙️ Restore PNPM cache
uses: actions/cache@v4
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-

- name: 📦 Install Dependencies
shell: bash
run: pnpm install --frozen-lockfile=false
62 changes: 62 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: 🧞‍♂️ CI

on:
pull_request:
branches:
- main
push:
branches:
- main

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

jobs:
build:
name: 🧱 Build (tsup)
runs-on: ubuntu-latest

steps:
- name: 📚 Checkout
uses: actions/checkout@v4

- name: ⚙️ Setup Environment and Dependencies
uses: ./.github/actions/setup-environment-n-deps

- name: 🧱 Build (tsup)
run: pnpm build

# Most likely not needed until monorepo:
# env:
# NODE_OPTIONS: --max-old-space-size=32768

# TODO: Enable later once I add the linter.
# lint:
# name: 🕵️ Lint (eslint)
# runs-on: ubuntu-latest

# steps:

# - name: 📚 Checkout
# uses: actions/checkout@v4

# - name: ⚙️ Setup Environment and Dependencies
# uses: ./.github/actions/setup-environment-n-deps

# - name: 🕵️ Lint (eslint)
# run: pnpm lint

test:
name: 🧪 Test (Jest)
runs-on: ubuntu-latest

steps:
- name: 📚 Checkout
uses: actions/checkout@v4

- name: ⚙️ Setup Environment and Dependencies
uses: ./.github/actions/setup-environment-n-deps

- name: 🧪 Test (Jest)
run: pnpm test
31 changes: 31 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# name: 🚀 Release

# on:
# push:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could set this one up to dispatch manually instead

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, that's a good idea!

# branches:
# - main

# jobs:

# publish:
# name: 🚀 Publish to NPM
# runs-on: ubuntu-latest

# env:
# ACTIONS_ALLOW_UNSECURE_COMMANDS: true

# steps:

# - name: 📚 Checkout
# uses: actions/checkout@v4

# - name: ⚙️ Setup Environment and Dependencies
# uses: ./.github/actions/setup-environment-n-deps

# - name: 🧱 Build (tsup)
# run: pnpm build

# - name: 🚀 Publish to NPM
# run: npm publish
# env:
# NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
92 changes: 92 additions & 0 deletions .github/workflows/security-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.

name: 👮‍♂️ Security Analysis

on:
pull_request:
branches:
- main
push:
branches:
- main
schedule:
- cron: "00 08 * * 1"

jobs:
analyze:
name: 🔍 Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
permissions:
# required for all workflows
security-events: write

# required to fetch internal or private CodeQL packs
packages: read

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: javascript-typescript
build-mode: none

# CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages

steps:
- name: 📚 Checkout
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: ⚙️ Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

- if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1

- name: 👮‍♂️ Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
"build": "tsc && vite build",
"storybook": "storybook dev -p 6006",
"build-storybook": "storybook build",
"clean": "rm -rf dist",
"nuke": "pnpm clean && rm -rf node_modules pnpm-lock.yaml",
"test": "echo \"Warning: no test specified\"",
"fmt": "prettier . --write"
},
"files": [
Expand All @@ -32,7 +35,7 @@
"@linaria/babel-preset": "^4.4.5",
"@linaria/core": "^4.2.10",
"@linaria/react": "^4.3.8",
"@othent/kms": "2.0.0",
"@othent/kms": "2.1.1",
"arweave": "^1.12.2",
"arweave-wallet-connector": "^1.0.2",
"framer-motion": "^8.1.9",
Expand Down
Loading