Merge pull request #23 from jcam1/develop

Release 2024-08-26 11:47:19 +0900

.github/.git-pr-release

@@ -0,0 +1,4 @@
+Release <%= Time.now %>
+<% pull_requests.each do |pr| -%>
+- #<%= pr.number %> <%= pr.title %> <%= pr.mention %>
+<% end -%>

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature Request
+about: Submit a feature request
+title: ''
+labels: ['feature request']
+assignees: ''
+---
+
+<!-- Edit issue title -->
+
+## 🌈 Overview
+
+<!-- Write a brief overview of this feature request in a few sentences -->
+
+## ❓ Motivation
+
+<!-- Summarize motivation/background of this feature request. Why should our SDK have this feature? -->
+
+## 🎨 Description
+
+<!-- Describe a detailed description of this feature request -->
+
+## 📚 References
+
+<!-- Put a list of external links related to this issue (if any) -->

.github/actions/install-dependencies/action.yml

@@ -0,0 +1,14 @@
+name: install dependencies
+description: set up node & install dependencies
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 20
+        registry-url: 'https://registry.npmjs.org'
+        scope: '@jpyc'
+    - name: Install dependencies
+      shell: bash
+      run: yarn --frozen-lockfile

.github/actions/publish-package/action.yml

@@ -0,0 +1,15 @@
+name: publish package
+description: publish an npm package
+inputs:
+  node-auth-token:
+    description: 'node token for authorization'
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Publish package
+      run: yarn publish
+      shell: bash
+      env:
+        NODE_AUTH_TOKEN: ${{ inputs.node-auth-token }}

.github/pull_request_template.md

@@ -8,7 +8,7 @@
 
 <!-- Provide a detailed description of the changes -->
 
-- 
+-
 
 ## 📚 References
 

.github/release-drafter.yml

@@ -0,0 +1,6 @@
+template: |
+  ## What's Changed
+
+  $CHANGES
+
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

.github/workflows/check.yml

@@ -0,0 +1,88 @@
+name: static checks
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  detect-changes:
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    permissions:
+      pull-requests: read
+    outputs:
+      root: ${{ steps.filter.outputs.root }}
+      core: ${{ steps.filter.outputs.core }}
+      v1: ${{ steps.filter.outputs.v1 }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            root:
+              - '.github/**'
+              - 'docs/**'
+              - 'README.md'
+            core:
+              - 'packages/core/**'
+            v1:
+              - 'packages/v1/**'
+
+  check-root:
+    needs: detect-changes
+    if: ${{ needs.detect-changes.outputs.root == 'true' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-dependencies
+      - name: Format
+        run: yarn run format:dry-run .github docs README.md
+
+  check-core:
+    needs: detect-changes
+    if: ${{ needs.detect-changes.outputs.core == 'true' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/core
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-dependencies
+      - name: Compile
+        run: yarn run compile
+      - name: Lint
+        run: yarn run lint:dry-run
+      - name: Format
+        run: yarn run format:dry-run
+      - name: Run tests
+        run: yarn run test
+
+  check-v1:
+    needs: detect-changes
+    if: ${{ needs.detect-changes.outputs.v1 == 'true' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/v1
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-dependencies
+      - name: Compile
+        run: yarn run compile:sdk
+      - name: Lint
+        run: yarn run lint:dry-run
+      - name: Format
+        run: yarn run format:dry-run

.github/workflows/create-release-pr.yml

@@ -0,0 +1,27 @@
+name: create a release pr from `develop` to `main`
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  create-release-pr:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - name: Create a release PR
+        env:
+          GIT_PR_RELEASE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GIT_PR_RELEASE_BRANCH_PRODUCTION: main
+          GIT_PR_RELEASE_BRANCH_STAGING: develop
+          GIT_PR_RELEASE_TEMPLATE: .github/.git-pr-release
+          GIT_PR_RELEASE_LABELS: release
+          TZ: Asia/Tokyo
+        run: |
+          gem install -N git-pr-release -v "2.2.0"
+          git-pr-release --no-fetch

.github/workflows/publish.yml

@@ -0,0 +1,101 @@
+name: publish packages to npm registry
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/core/**'
+      - 'packages/v1/**'
+
+jobs:
+  detect-changes:
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    permissions:
+      pull-requests: read
+    outputs:
+      core: ${{ steps.filter.outputs.core }}
+      v1: ${{ steps.filter.outputs.v1 }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            core:
+              - 'packages/core/**'
+            v1:
+              - 'packages/v1/**'
+
+  push-git-tag:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./
+    timeout-minutes: 3
+    outputs:
+      tag-name: ${{ 'v' }}${{ env.GIT_TAG_VERSION }}
+      tag-version: ${{ env.GIT_TAG_VERSION }}
+      tag-exists: ${{ steps.create-tag.outputs.tag_exists }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-dependencies
+      - name: get version from `package.json`
+        run: node -p -e '`GIT_TAG_VERSION=${require("./package.json").version}`' >> $GITHUB_ENV
+      - uses: rickstaa/action-create-tag@v1
+        id: create-tag
+        with:
+          tag: ${{ 'v' }}${{ env.GIT_TAG_VERSION }}
+
+  publish-release-note:
+    needs: push-git-tag
+    if: ${{ needs.push-git-tag.outputs.tag-exists == 'false' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./
+    timeout-minutes: 5
+    permissions:
+      contents: write
+      pull-requests: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: release-drafter/release-drafter@v6
+        with:
+          name: ${{ needs.push-git-tag.outputs.tag-name }}
+          tag: ${{ needs.push-git-tag.outputs.tag-name }}
+          version: ${{ needs.push-git-tag.outputs.tag-version }}
+          publish: 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-core:
+    needs: [detect-changes, publish-release-note]
+    if: ${{ needs.detect-changes.outputs.core == 'true' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/core
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-dependencies
+      - uses: ./.github/actions/publish-package
+        with:
+          node-auth-token: ${{ secrets.NPM_TOKEN }}
+
+  publish-v1:
+    needs: [detect-changes, publish-release-note]
+    if: ${{ needs.detect-changes.outputs.v1 == 'true' }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/v1
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/install-dependencies
+      - uses: ./.github/actions/publish-package
+        with:
+          node-auth-token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -128,3 +128,7 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# Misc
+.DS_Store
+.vscode

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "packages/v1/JPYCv2"]
+	path = packages/v1/JPYCv2
+	url = https://github.com/jcam1/JPYCv2.git

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 100,
+  "semi": true,
+  "singleQuote": true,
+  "quoteProps": "consistent",
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "always"
+}