-
Notifications
You must be signed in to change notification settings - Fork 363
Add npm publish workflow #89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,4 +27,6 @@ jobs: | |
|
|
||
| - run: npm run build:all | ||
|
|
||
| - run: npm test | ||
|
|
||
| - run: npm run prettier | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| name: Publish to npm | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: oven-sh/setup-bun@v2 | ||
| with: | ||
| bun-version: latest | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: npm | ||
| - run: npm ci | ||
| - run: npm run build | ||
| - run: npm run prettier | ||
|
|
||
| test: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: oven-sh/setup-bun@v2 | ||
| with: | ||
| bun-version: latest | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: npm | ||
| - run: npm ci | ||
| - run: npm test | ||
|
|
||
| publish: | ||
|
|
||
| runs-on: ubuntu-latest | ||
| if: github.event_name == 'release' | ||
| environment: release | ||
| needs: [build, test] | ||
|
|
||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: oven-sh/setup-bun@v2 | ||
| with: | ||
| bun-version: latest | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: npm | ||
| registry-url: "https://registry.npmjs.org" | ||
| - run: npm ci | ||
|
|
||
| - name: Determine npm tag | ||
| id: npm-tag | ||
| run: | | ||
| VERSION=$(node -p "require('./package.json').version") | ||
| # Check if this is a beta release | ||
| if [[ "$VERSION" == *"-beta"* ]]; then | ||
| echo "tag=--tag beta" >> $GITHUB_OUTPUT | ||
| # Check if this release is from a non-main branch (patch/maintenance release) | ||
| elif [[ "${{ github.event.release.target_commitish }}" != "main" ]]; then | ||
| # Use "release-X.Y" as tag for old branch releases | ||
| MAJOR_MINOR=$(echo "$VERSION" | cut -d. -f1,2) | ||
| echo "tag=--tag release-${MAJOR_MINOR}" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "tag=" >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
||
| - run: npm publish --provenance --access public ${{ steps.npm-tag.outputs.tag }} | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| # Contributing to MCP Apps SDK | ||
|
|
||
| We welcome contributions to the MCP Apps SDK! This document outlines the process for contributing to the project. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Fork the repository | ||
| 2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/ext-apps.git` | ||
| 3. Install dependencies: `npm install` | ||
| 4. Build the project: `npm run build` | ||
| 5. Run tests: `npm test` | ||
|
|
||
| ## Development Process | ||
|
|
||
| 1. Create a new branch for your changes | ||
| 2. Make your changes | ||
| 3. Run `npm run prettier` to ensure code style compliance | ||
| 4. Run `npm test` to verify all tests pass | ||
| 5. Submit a pull request | ||
|
|
||
| ## Pull Request Guidelines | ||
|
|
||
| - Follow the existing code style | ||
| - Include tests for new functionality | ||
| - Update documentation as needed | ||
| - Keep changes focused and atomic | ||
| - Provide a clear description of changes | ||
|
|
||
| ## Running Examples | ||
|
|
||
| Start the development environment with hot reloading: | ||
|
|
||
| ```bash | ||
| npm run examples:dev | ||
| ``` | ||
|
|
||
| Or build and run examples: | ||
|
|
||
| ```bash | ||
| npm run examples:start | ||
| ``` | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it before contributing. | ||
|
|
||
| ## Reporting Issues | ||
|
|
||
| - Use the [GitHub issue tracker](https://github.com/modelcontextprotocol/ext-apps/issues) | ||
| - Search existing issues before creating a new one | ||
| - Provide clear reproduction steps | ||
|
|
||
| ## Security Issues | ||
|
|
||
| Please review our [Security Policy](SECURITY.md) for reporting security vulnerabilities. | ||
|
|
||
| --- | ||
|
|
||
| ## For Maintainers | ||
|
|
||
| ### Repository Setup | ||
|
|
||
| Before publishing releases, ensure the following are configured: | ||
|
|
||
| 1. **NPM_TOKEN secret**: Add an npm automation token to the repository secrets | ||
| - Go to Settings � Secrets and variables � Actions | ||
| - Create a new secret named `NPM_TOKEN` | ||
| - Value: an npm automation token with publish permissions for `@modelcontextprotocol/ext-apps` | ||
|
|
||
| 2. **`release` environment** (optional): Create a protected environment for additional safeguards | ||
| - Go to Settings � Environments � New environment | ||
| - Name it `release` | ||
| - Add required reviewers or other protection rules as needed | ||
|
|
||
| ### Publishing a Release | ||
|
|
||
| Releases are published automatically via GitHub Actions when a GitHub Release is created. | ||
|
|
||
| #### Steps to publish: | ||
|
|
||
| 1. **Update the version** in `package.json`: | ||
|
|
||
| ```bash | ||
| # For a regular release | ||
| npm version patch # or minor, or major | ||
|
|
||
| # For a beta release | ||
| npm version prerelease --preid=beta | ||
| ``` | ||
|
|
||
| 2. **Commit the version bump** (if not done by `npm version`): | ||
|
|
||
| ```bash | ||
| git add package.json | ||
| git commit -m "Bump version to X.Y.Z" | ||
| git push origin main | ||
| ``` | ||
|
|
||
| 3. **Create a GitHub Release**: | ||
| - Go to [Releases](https://github.com/modelcontextprotocol/ext-apps/releases) | ||
| - Click "Draft a new release" | ||
| - Create a new tag matching the version (e.g., `v0.1.0`) | ||
| - Set the target branch (usually `main`) | ||
| - Write release notes describing the changes | ||
| - Click "Publish release" | ||
|
|
||
| 4. **Monitor the workflow**: | ||
| - The [npm-publish workflow](https://github.com/modelcontextprotocol/ext-apps/actions/workflows/npm-publish.yml) will trigger automatically | ||
| - It runs build and test jobs before publishing | ||
| - On success, the package is published to npm with provenance | ||
|
|
||
| #### npm Tags | ||
|
|
||
| The workflow automatically determines the npm dist-tag: | ||
|
|
||
| | Version Pattern | npm Tag | Install Command | | ||
| | ----------------------------- | ------------- | -------------------------------------------------------- | | ||
| | `X.Y.Z` (from main) | `latest` | `npm install @modelcontextprotocol/ext-apps` | | ||
| | `X.Y.Z-beta.N` | `beta` | `npm install @modelcontextprotocol/ext-apps@beta` | | ||
| | `X.Y.Z` (from release branch) | `release-X.Y` | `npm install @modelcontextprotocol/ext-apps@release-X.Y` | | ||
|
|
||
| #### Maintenance Releases | ||
|
|
||
| To release a patch for an older version: | ||
|
|
||
| 1. Create a release branch from the tag: `git checkout -b release-0.1 v0.1.0` | ||
| 2. Cherry-pick or apply fixes | ||
| 3. Bump the patch version | ||
| 4. Create a GitHub Release targeting the release branch | ||
| 5. The package will be published with tag `release-0.1` | ||
|
|
||
| ### Testing Pre-releases | ||
|
|
||
| Every commit and PR automatically publishes a preview package via [pkg-pr-new](https://github.com/pkg-pr-new/pkg-pr-new). Check the PR comments or workflow logs for the install command. | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| By contributing, you agree that your contributions will be licensed under the MIT License. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.