obsidian-ci-integration

•

1.9k2653 months ago

Set up GitHub Actions CI/CD for Obsidian plugin development. Use when automating builds, tests, and releases for your plugin, or setting up continuous integration for Obsidian projects. Trigger with phrases like "obsidian CI", "obsidian github actions", "obsidian automated build", "obsidian CI/CD".

Quick Install

npxskills add jeremylongshore/claude-code-plugins-plus-skills--skill obsidian-ci-integration

Instructions

Obsidian CI Integration

Overview

GitHub Actions workflows for Obsidian plugin development: build validation on every push, automated releases when you tag, version-bump scripting, manifest.json validation, and BRAT beta channel support.

Prerequisites

GitHub repository with an Obsidian plugin
Working local build (npm run build produces main.js)
manifest.json and versions.json in repo root
GitHub Actions enabled on the repository

Instructions

Step 1: Create Build Workflow

# .github/workflows/build.yml
name: Build Plugin
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 18

      - name: Install dependencies
        run: npm ci

      - name: Build plugin
        run: npm run build

      - name: Verify build output
        run: |
          if [ ! -f main.js ]; then
            echo "ERROR: main.js not found after build"
            exit 1
          fi
          echo "main.js size: $(wc -c < main.js) bytes"

      - name: Validate manifest.json
        run: |
          node -e "
            const m = require('./manifest.json');
            const required = ['id', 'name', 'version', 'minAppVersion', 'description', 'author'];
            const missing = required.filter(f => !m[f]);
            if (missing.length) {
              console.error('Missing manifest fields:', missing.join(', '));
              process.exit(1);
            }
            console.log('manifest.json valid:', m.id, 'v' + m.version);
          "

Loading…

Related Skills

skill-creator

Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.

367,360

skill-creator

Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.

367,309

obsidian

Work with Obsidian vaults (plain Markdown notes) and automate via obsidian-cli.

359,291

1password

Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.

365,915

Tags & Topics

aiautomationclaude-codedevopsmcpai-agents

Obsidian CI Integration

Overview

Prerequisites

GitHub repository with an Obsidian plugin
Working local build (npm run build produces main.js)
manifest.json and versions.json in repo root
GitHub Actions enabled on the repository

Instructions

Step 1: Create Build Workflow

# .github/workflows/build.yml
name: Build Plugin
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 18

      - name: Install dependencies
        run: npm ci

      - name: Build plugin
        run: npm run build

      - name: Verify build output
        run: |
          if [ ! -f main.js ]; then
            echo "ERROR: main.js not found after build"
            exit 1
          fi
          echo "main.js size: $(wc -c < main.js) bytes"

      - name: Validate manifest.json
        run: |
          node -e "
            const m = require('./manifest.json');
            const required = ['id', 'name', 'version', 'minAppVersion', 'description', 'author'];
            const missing = required.filter(f => !m[f]);
            if (missing.length) {
              console.error('Missing manifest fields:', missing.join(', '));
              process.exit(1);
            }
            console.log('manifest.json valid:', m.id, 'v' + m.version);
          "

Error	Cause	Solution
`main.js not found`	Build script doesn't output to root	Check esbuild `outfile` points to `./main.js`
Release has no assets	Tag pushed before build	Let the release workflow handle the build, don't attach manually
Version mismatch	Forgot `npm version`	Run `npm version patch` instead of editing manifest by hand
BRAT not picking up beta	No pre-release on GitHub	Create release and check "pre-release" checkbox
`npm ci` fails	No lockfile	Commit `package-lock.json` to the repo
Permission denied on release	Missing `contents: write`	Add `permissions` block to release job

obsidian-ci-integration

Obsidian CI Integration

Overview

Prerequisites

Instructions

Step 1: Create Build Workflow

Related Skills

skill-creator

skill-creator

obsidian

1password

Obsidian CI Integration

Overview

Prerequisites

Instructions

Step 1: Create Build Workflow

Step 2: Create Release Workflow

Step 3: Create Version Bump Script

Step 4: Wire Version Bump into package.json

Step 5: Add Manifest Validation Workflow

Step 6: BRAT Beta Support

Output

Error Handling

Examples

Tag and Release a New Version

Manual Build Verification

Release with Changelog

Resources

Next Steps

Related Skills

skill-creator

skill-creator

obsidian

1password

Related Skills

skill-creator

skill-creator

obsidian

1password