Yuque MCP Server

🚀 GitHub Actions Workflow Usage Guide

This guide provides a detailed introduction to the GitHub Actions workflows configured in this repository, including their functions, usage methods, and configuration requirements.

🚀 Quick Start

✨ Features

This repository is configured with the following GitHub Actions workflows:

• Version Bump (version-bump): Automatically updates the version number of the npm package.
• NPM Package Publishing (npm-publish): Automatically builds and publishes the npm package to npmjs.com.

📦 Installation

No specific installation steps are required as these workflows are integrated into the GitHub Actions of the repository.

💻 Usage Examples

Version Bump Workflow

You can manually trigger the version bump through the GitHub interface:

1. Navigate to the "Actions" tab of the repository.
2. Select the "Version Bump" workflow.
3. Click the "Run workflow" button.
4. Choose the version bump type (patch, minor, or major).
5. Click "Run workflow" to confirm.

The workflow will automatically:

• Update the version number in package.json.
• Create the corresponding Git tag.
• Commit and push all changes.

NPM Package Publishing Workflow

This workflow is automatically triggered in the following cases:

1. When a new GitHub release is created.
2. When manually triggered.

To manually trigger the publishing process:

1. Navigate to the "Actions" tab of the repository.
2. Select the "Publish NPM Package" workflow.
3. Click the "Run workflow" button.
4. Click "Run workflow" to confirm.

🔧 Technical Details

Configuring the NPM Publishing Token

To ensure the normal operation of the NPM publishing workflow, you need to configure the NPM token in the GitHub repository:

1. Generate an access token on the npm website (https://www.npmjs.com/settings/[username]/tokens).
2. In the GitHub repository, go to "Settings" > "Secrets and variables" > "Actions".
3. Click "New repository secret".
4. Enter NPM_TOKEN as the name and your npm access token as the value.
5. Click "Add secret" to save.