Merge branch 'develop' into pr/12808

.config/example.yml

@@ -160,14 +160,14 @@ id: 'aidx'
 # Job concurrency per worker
 #deliverJobConcurrency: 128
 #inboxJobConcurrency: 16
-#relashionshipJobConcurrency: 16
-# What's relashionshipJob?:
+#relationshipJobConcurrency: 16
+# What's relationshipJob?:
 #  Follow, unfollow, block and unblock(ings) while following-imports, etc. or account migrations.
 
 # Job rate limiter
 #deliverJobPerSec: 128
 #inboxJobPerSec: 32
-#relashionshipJobPerSec: 64
+#relationshipJobPerSec: 64
 
 # Job attempts
 #deliverJobMaxAttempts: 12

.github/workflows/changelog-check.yml

@@ -0,0 +1,43 @@
+name: Check the description in CHANGELOG.md
+
+on:
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  check-changelog:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout head
+        uses: actions/checkout@v4.1.1
+      - name: Setup Node.js
+        uses: actions/setup-node@v4.0.1
+        with:
+          node-version-file: '.node-version'
+
+      - name: Checkout base
+        run: |
+          mkdir _base
+          cp -r .git _base/.git
+          cd _base
+          git fetch --depth 1 origin ${{ github.base_ref }}
+          git checkout origin/${{ github.base_ref }} CHANGELOG.md
+
+      - name: Copy to Checker directory for CHANGELOG-base.md
+        run: cp _base/CHANGELOG.md scripts/changelog-checker/CHANGELOG-base.md
+      - name: Copy to Checker directory for CHANGELOG-head.md
+        run: cp CHANGELOG.md scripts/changelog-checker/CHANGELOG-head.md
+      - name: diff
+        continue-on-error: true
+        run: diff -u CHANGELOG-base.md CHANGELOG-head.md
+        working-directory: scripts/changelog-checker
+
+      - name: Setup Checker
+        run: npm install
+        working-directory: scripts/changelog-checker
+      - name: Run Checker
+        run: npm run run
+        working-directory: scripts/changelog-checker

.github/workflows/check-misskey-js-autogen.yml

@@ -0,0 +1,134 @@
+name: Check Misskey JS autogen
+
+on:
+  pull_request_target:
+    branches:
+      - master
+      - develop
+    paths:
+      - packages/backend/**
+
+jobs:
+  check-misskey-js-autogen:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+
+    env:
+      api_json_name: "api-head.json"
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: setup node
+        id: setup-node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.node-version'
+          cache: pnpm
+
+      - name: install dependencies
+        run: pnpm i --frozen-lockfile
+
+      - name: wait get-api-diff
+        uses: lewagon/wait-on-check-action@v1.3.3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          check-regexp: get-from-misskey .+
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          wait-interval: 30
+
+      - name: Download artifact
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+
+            const workflows = await github.rest.actions.listWorkflowRunsForRepo({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              head_sha: `${{ github.event.pull_request.head.sha }}`
+            }).then(x => x.data.workflow_runs);
+
+            console.log(workflows.map(x => ({name: x.name, title: x.display_title})));
+
+            const run_id = workflows.find(x => x.name.includes("Get api.json from Misskey")).id;
+
+            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: run_id,
+            });
+
+            let matchArtifacts = allArtifacts.data.artifacts.filter((artifact) => {
+              return artifact.name.startsWith("api-artifact-") || artifact.name == "api-artifact"
+            });
+
+            await Promise.all(matchArtifacts.map(async (artifact) => {
+              let download = await github.rest.actions.downloadArtifact({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                artifact_id: artifact.id,
+                archive_format: 'zip',
+              });
+              await fs.promises.writeFile(`${process.env.GITHUB_WORKSPACE}/${artifact.name}.zip`, Buffer.from(download.data));
+            }));
+
+      - name: unzip artifacts
+        run: |-
+          find . -mindepth 1 -maxdepth 1 -type f -name '*.zip' -exec unzip {} -d . ';'
+          ls -la
+
+      - name: get head checksum
+        run: |-
+          checksum=$(realpath head_checksum)
+
+          cd packages/misskey-js/src
+          find autogen -type f -exec sh -c 'echo $(sed -E "s/^\s+\*\s+generatedAt:.+$//" {} | sha256sum | cut -d" " -f 1) {}' \; > $checksum
+          cd ../../..
+
+      - name: build autogen
+        run: |-
+            checksum=$(realpath ${api_json_name}_checksum)
+            mv $api_json_name packages/misskey-js/generator/api.json
+
+            cd packages/misskey-js/generator
+            pnpm run generate
+            cd built
+            find autogen -type f -exec sh -c 'echo $(sed -E "s/^\s+\*\s+generatedAt:.+$//" {} | sha256sum | cut -d" " -f 1) {}' \; > $checksum
+            cd ../../../..
+
+      - name: check update for type definitions
+        run: diff head_checksum ${api_json_name}_checksum
+
+      - name: send message
+        if: failure()
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          comment_tag: check-misskey-js-autogen
+          message: |-
+            Thank you for sending us a great Pull Request! 👍
+            Please regenerate misskey-js type definitions! 🙏
+
+            example:
+            ```sh
+            pnpm run build-misskey-js-with-types
+            ```
+
+      - name: send message
+        if: success()
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          comment_tag: check-misskey-js-autogen
+          mode: delete
+          message: "Thank you!"
+          create_if_not_exists: false

.github/workflows/deploy-test-environment.yml

@@ -0,0 +1,66 @@
+name: Deploy test environment
+
+on:
+  push:
+  workflow_dispatch:
+    inputs:
+      repository:
+        description: 'Repository to deploy (optional)'
+        required: false
+      branch:
+        description: 'Branch to deploy (optional)'
+        required: false
+
+jobs:
+  deploy-test-environment:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set environment variable (for tput command & pnpm)
+      run: |
+        echo "TERM=xterm" >> $GITHUB_ENV
+        REPOSITORY=${{ github.event.inputs.repository || github.repository }}
+        echo "REPOSITORY=$REPOSITORY" >> $GITHUB_ENV
+        BRANCH=${{ github.event.inputs.branch || github.ref_name }}
+        echo "BRANCH=$BRANCH" >> $GITHUB_ENV
+
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        repository: ${{ env.REPOSITORY }}
+        ref: ${{ env.BRANCH }}
+
+    - name: Get the latest commit SHA
+      run: |
+        SHA=$(git log -1 --format="%H")
+        echo "SHA=$SHA" >> $GITHUB_ENV
+
+    - name: Start cloudflare tunnel (quick)
+      run: |
+        wget https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64.deb
+        sudo dpkg -i cloudflared-linux-amd64.deb
+        sudo cloudflared tunnel --metrics localhost:55555 --url localhost:3000 > /dev/null 2>&1 &
+        sleep 15
+        TUNNEL_RESPONSE=$(curl http://localhost:55555/quicktunnel)
+        TUNNEL_DOMAIN=$(echo $TUNNEL_RESPONSE | grep -o '"hostname":"[^"]*' | grep -o '[^"]*$')
+        echo "::add-mask::$TUNNEL_DOMAIN"
+        echo "TUNNEL_DOMAIN=$TUNNEL_DOMAIN" >> $GITHUB_ENV
+
+    - name: Install misskey
+      run: |
+        wget https://raw.githubusercontent.com/joinmisskey/bash-install/v4/misskey-install.sh
+        wget https://raw.githubusercontent.com/joinmisskey/bash-install/v4/testenv_githubactions.txt
+        sed -i "s/host=127.0.0.1/host=$TUNNEL_DOMAIN/g" testenv_githubactions.txt
+        sed -i "s|git_repository=https://github.com/misskey-dev/misskey|git_repository=https://github.com/$REPOSITORY|g" testenv_githubactions.txt
+        sed -i "s|git_branch=master|git_branch=$BRANCH|g" testenv_githubactions.txt
+        sudo chmod 555 ./misskey-install.sh
+        sudo bash -x ./misskey-install.sh -c ./testenv_githubactions.txt
+
+    - name: Post tunnel info to Discord
+      run: |
+        CURRENT_TIME=$(TZ=Asia/Tokyo date +'%Y-%m-%d %H:%M:%S JST')
+        COMMIT_URL="https://github.com/$REPOSITORY/commit/$SHA"
+        curl -X POST -H "Content-Type: application/json" -d "{\"content\": \"==============================\nURL: https://$TUNNEL_DOMAIN\nRepository: $REPOSITORY\nBranch: $BRANCH\nCommit: $COMMIT_URL\nTime: $CURRENT_TIME\n==============================\"}" ${{ secrets.DISCORD_WEBHOOK_URL }}
+
+    - name: Wait
+      run: |
+        timeout 3600 tail -f /var/log/syslog || true

.github/workflows/lint.yml

@@ -92,4 +92,6 @@ jobs:
     - run: pnpm i --frozen-lockfile
     - run: pnpm --filter misskey-js run build
       if: ${{ matrix.workspace == 'backend' }}
+    - run: pnpm --filter misskey-reversi run build:tsc
+      if: ${{ matrix.workspace == 'backend' }}
     - run: pnpm --filter ${{ matrix.workspace }} run typecheck

.github/workflows/on-release-created.yml

@@ -0,0 +1,45 @@
+name: On Release Created (Publish misskey-js)
+
+on:
+  release:
+    types: [created]
+
+  workflow_dispatch:
+
+jobs:
+  publish-misskey-js:
+    name: Publish misskey-js
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    strategy:
+      matrix:
+        node-version: [20.10.0]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Publish package
+        run: |
+          corepack enable
+          pnpm i --frozen-lockfile
+          pnpm build
+          pnpm --filter misskey-js publish --access public --no-git-checks --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}

.github/workflows/test-misskey-js.yml

@@ -54,3 +54,17 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./packages/misskey-js/coverage/coverage-final.json
+
+  check-version:
+    # ルートの package.json と packages/misskey-js/package.json のバージョンが一致しているかを確認する
+    name: Check version
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.1.1
+      - name: Check version
+        run: |
+          if [ "$(jq -r '.version' package.json)" != "$(jq -r '.version' packages/misskey-js/package.json)" ]; then
+            echo "Version mismatch!"
+            exit 1
+          fi

.github/workflows/validate-api-json.yml

@@ -0,0 +1,47 @@
+name: Test (backend)
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+    paths:
+      - packages/backend/**
+  pull_request:
+    paths:
+      - packages/backend/**
+
+jobs:
+  validate-api-json:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.10.0]
+
+    steps:
+    - uses: actions/checkout@v4.1.1
+      with:
+        submodules: true
+    - name: Install pnpm
+      uses: pnpm/action-setup@v2
+      with:
+        version: 8
+        run_install: false
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4.0.1
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install Redocly CLI
+      run: npm i -g @redocly/cli
+    - run: corepack enable
+    - run: pnpm i --frozen-lockfile
+    - name: Check pnpm-lock.yaml
+      run: git diff --exit-code pnpm-lock.yaml
+    - name: Copy Configure
+      run: cp .config/example.yml .config/default.yml
+    - name: Build and generate
+      run: pnpm build && pnpm --filter backend generate-api-json
+    - name: Validation
+      run: npx @redocly/cli lint --extends=minimal ./packages/backend/built/api.json

.gitignore

@@ -58,6 +58,7 @@ api-docs.json
 ormconfig.json
 temp
 /packages/frontend/src/**/*.stories.ts
+tsdoc-metadata.json
 
 # blender backups
 *.blend1