Merge branch 'feature/github-release-workflow'
This commit is contained in:
104
.github/workflows/release.yml
vendored
Normal file
104
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,104 @@
|
||||
name: Release Plugin
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "[0-9]+.[0-9]+.[0-9]+"
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Validate version consistency
|
||||
run: |
|
||||
TAG_VERSION="${GITHUB_REF#refs/tags/}"
|
||||
PKG_VERSION=$(node -p "require('./package.json').version")
|
||||
MANIFEST_VERSION=$(node -p "require('./manifest.json').version")
|
||||
|
||||
echo "Checking version consistency..."
|
||||
echo "Git tag: $TAG_VERSION"
|
||||
echo "package.json: $PKG_VERSION"
|
||||
echo "manifest.json: $MANIFEST_VERSION"
|
||||
|
||||
if [ "$TAG_VERSION" != "$PKG_VERSION" ] || [ "$TAG_VERSION" != "$MANIFEST_VERSION" ]; then
|
||||
echo "❌ Version mismatch detected!"
|
||||
echo "Git tag: $TAG_VERSION"
|
||||
echo "package.json: $PKG_VERSION"
|
||||
echo "manifest.json: $MANIFEST_VERSION"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ All versions match: $TAG_VERSION"
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '18'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run tests
|
||||
run: npm test
|
||||
|
||||
- name: Build plugin
|
||||
run: npm run build
|
||||
|
||||
- name: Verify build artifacts
|
||||
run: |
|
||||
echo "Verifying required files exist..."
|
||||
|
||||
if [ ! -f main.js ]; then
|
||||
echo "❌ main.js not found!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -f manifest.json ]; then
|
||||
echo "❌ manifest.json not found!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -f styles.css ]; then
|
||||
echo "❌ styles.css not found!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ All required files present"
|
||||
echo "File sizes:"
|
||||
ls -lh main.js manifest.json styles.css
|
||||
|
||||
- name: Create draft release
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
TAG_VERSION="${GITHUB_REF#refs/tags/}"
|
||||
|
||||
gh release create "$TAG_VERSION" \
|
||||
--title="$TAG_VERSION" \
|
||||
--draft \
|
||||
--notes="Release $TAG_VERSION
|
||||
|
||||
## Changes
|
||||
|
||||
*Add release notes here before publishing*
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download \`main.js\`, \`manifest.json\`, and \`styles.css\`
|
||||
2. Create a folder in \`.obsidian/plugins/obsidian-mcp-server/\`
|
||||
3. Copy the three files into the folder
|
||||
4. Reload Obsidian
|
||||
5. Enable the plugin in Settings → Community Plugins" \
|
||||
main.js \
|
||||
manifest.json \
|
||||
styles.css
|
||||
|
||||
echo "✅ Draft release created: $TAG_VERSION"
|
||||
echo "Visit https://github.com/${{ github.repository }}/releases to review and publish"
|
||||
28
CLAUDE.md
28
CLAUDE.md
@@ -234,6 +234,34 @@ This plugin is **desktop-only** (`isDesktopOnly: true`) because it uses Node.js
|
||||
- Create GitHub releases with tags that **exactly match** `manifest.json` version (no `v` prefix)
|
||||
- Attach required assets to releases: `manifest.json`, `main.js`, `styles.css`
|
||||
|
||||
#### GitHub Release Workflow
|
||||
|
||||
A GitHub Actions workflow automatically handles releases:
|
||||
|
||||
**Location**: `.github/workflows/release.yml`
|
||||
|
||||
**Trigger**: Push of semantic version tags (e.g., `1.2.3`)
|
||||
|
||||
**Process**:
|
||||
1. Validates version consistency across `package.json`, `manifest.json`, and git tag
|
||||
2. Runs full test suite (blocks release if tests fail)
|
||||
3. Builds plugin with production config
|
||||
4. Creates draft GitHub release with `main.js`, `manifest.json`, and `styles.css`
|
||||
|
||||
**Developer workflow**:
|
||||
```bash
|
||||
npm version patch # or minor/major - updates manifest.json via version-bump.mjs
|
||||
git commit -m "chore: bump version to X.Y.Z"
|
||||
git tag X.Y.Z
|
||||
git push && git push --tags # Triggers workflow
|
||||
```
|
||||
|
||||
After workflow completes:
|
||||
1. Go to GitHub Releases
|
||||
2. Review draft release and attached files
|
||||
3. Write release notes
|
||||
4. Publish release
|
||||
|
||||
### Build Artifacts
|
||||
|
||||
- **Never commit build artifacts** to version control (`main.js`, `node_modules/`, etc.)
|
||||
|
||||
Reference in New Issue
Block a user