Skip to content

Add plugin release workflow and installation guide#111

Merged
petersalomonsen merged 6 commits intomasterfrom
feature/plugin-release-workflow
Sep 7, 2025
Merged

Add plugin release workflow and installation guide#111
petersalomonsen merged 6 commits intomasterfrom
feature/plugin-release-workflow

Conversation

@petersalomonsen
Copy link
Owner

@petersalomonsen petersalomonsen commented Sep 7, 2025

Summary

  • Added automated release workflow for the JUCE plugin on macOS
  • Created comprehensive installation documentation
  • Configured GitHub Actions to build and package releases
  • Fixed Near API JS dependency issues affecting tests

Changes

Release Workflow

  • Extended .github/workflows/macos-build.yml:
    • Added triggers for version tags (v*) and manual dispatch
    • Fixed cmake installation conflicts on macOS runners
    • Added packaging step that bundles the plugin with installation instructions
    • Configured automatic GitHub release creation when tags are pushed
    • Added artifact upload for all builds (not just releases)

Installation Documentation

  • Created dawplugin/INSTALLATION.md:
    • Detailed installation instructions for macOS users
    • Steps for handling macOS Gatekeeper security warnings
    • Troubleshooting guide with system xattr command fix
    • List of supported DAWs
    • Plugin features overview

Test Fixes

  • Fixed Near API JS dependency:
    • Updated from broken GitHub URL (nearprotocol/near-api-js) to npm CDN
    • Pinned to v1.1.0 (latest compatible version before v2.0.0 breaking changes)
    • Fixed in wasmgit/nearacl.js and midisequencer/ui/pianorolldemo/index.html
  • Updated web-test-runner.config.js:
    • Added test timeout configuration
    • All tests now passing

Test Plan

  • Push this PR to trigger the workflow
  • Verify the plugin builds successfully
  • Check that artifacts are uploaded correctly
  • Test creating a release by pushing a tag
  • Verify the ZIP package contains both the plugin and installation guide
  • Test installation on macOS and verify security warning handling
  • Verify all tests pass with the Near API JS fix

How to Create a Release

  1. Tag your commit: git tag v1.0.0
  2. Push the tag: git push origin v1.0.0
  3. The workflow will automatically build and create a GitHub release

Testing Results

  • Successfully created and tested v0.0.1 release
  • Plugin installs and works in GarageBand after following security instructions
  • All tests passing with Near API JS v1.1.0

🤖 Generated with Claude Code

petersalomonsen and others added 3 commits September 7, 2025 14:40
- Extended macOS build workflow to create GitHub releases
- Added packaging step to bundle plugin with installation instructions
- Added workflow triggers for version tags and manual dispatch
- Created comprehensive installation guide for macOS users
- Configured automatic artifact uploads for all builds

This enables automated releases when pushing version tags (v*) and
provides users with clear installation instructions bundled with
the plugin download.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Handle existing cmake installations from different Homebrew taps
by uninstalling before reinstalling
Use /usr/bin/xattr to avoid Python version conflicts with Homebrew installations
@petersalomonsen
Copy link
Owner Author

@race-of-sloths include

@race-of-sloths
Copy link

race-of-sloths commented Sep 7, 2025

@petersalomonsen Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
Are you going to win race-of-sloths this month? If so, you should speed up! Run, Sloth, run!

Shows inviting banner with latest news.

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@race-of-sloths 1

Your contribution is much appreciated with a final score of 1!
You have received 12 (10 base + 20% lifetime bonus) Sloth points for this contribution

We would appreciate your feedback or contribution idea that you can submit here

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

  • Tag @race-of-sloths inside your pull requests
  • Wait for the maintainer to review and score your pull request
  • Check out your position in the Leaderboard
  • Keep weekly and monthly streaks to reach higher positions
  • Boast your contributions with a dynamic picture of your Profile

For maintainers:

  • Score pull requests that participate in the Race of Sloths and receive a reward
  • Engage contributors with fair scoring and fast responses so they keep their streaks
  • Promote the Race to the point where the Race starts promoting you
  • Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands
  • For contributors
    • Include a PR: @race-of-sloths include to enter the Race with your PR
  • For maintainers:
    • Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
    • Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
    • Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
    • Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

- Updated Near API JS from broken GitHub URL to npm CDN
- Pinned to v1.1.0 (latest compatible version, v2.0.0 breaks)
- Fixed test timeout configuration
- All tests now passing
@petersalomonsen petersalomonsen marked this pull request as ready for review September 7, 2025 18:06
- Switch to faster RPC endpoint: rpc.mainnet.fastnear.com
- Update wallet URL to MyNearWallet: app.mynearwallet.com
- wallet.near.org is deprecated, replaced by MyNearWallet
- v1.1.0 breaks wasmgitclient tests due to keyStore API changes
- v0.44.2 is the stable version that works with all tests
- Both editorcontroller and wasmgitclient tests now pass
@petersalomonsen petersalomonsen merged commit 8917202 into master Sep 7, 2025
7 checks passed
@petersalomonsen petersalomonsen deleted the feature/plugin-release-workflow branch September 7, 2025 18:38
@race-of-sloths
Copy link

🥁 Score it!

@petersalomonsen, please ask your peers to score the PR using @race-of-sloths score [1/2/3/5/8/13].
If no scoring is provided within 24 hours, this PR will be scored as 1 🦥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants