MCP Server Sequential Thinking

🚀 How to Publish an npm Package and Configure CI/CD

This guide provides a step-by-step process on how to publish an npm package and configure CI/CD for seamless deployment.

🚀 Quick Start

🔑 Generate an Access Token

1. Log in to your npm account: Open your browser and go to https://www.npmjs.com/login.
2. Create a new token:
   • After logging in, click on your user avatar in the top-right corner.
   • Select “Access Tokens” from the dropdown menu.
   • Click the “New Access Token” button on the page.
   • Enter a description for the token, e.g., “GitHub Actions”.
3. Download and save the token:
   • Check the required permissions, such as “Read packages” and “Write packages”.
   • Click the “Create Token” button.
   • Immediately copy the generated token and save it securely.
4. Set up GitHub Secrets:
   • Open your GitHub repository and select “Settings” from the left sidebar.
   • In the “Secrets” section, click the “Add a secret” button.
   • Enter NPM_TOKEN as the secret name, paste the generated token value, and save it.

🐳 Configure Docker Hub Secrets

1. Log in to your Docker account: Visit https://hub.docker.com and log in with your credentials.
2. Create a new token:
   • Navigate to “Account Settings”.
   • Select “Security” from the left sidebar.
   • Click “New Access Token” and add a description for the token, e.g., “GitHub Actions”.
3. Get your Docker account information:
   • Note down your Docker Hub username, which is usually displayed on your profile page.
4. Set up GitHub Secrets:
   • Return to the “Secrets” section of your GitHub repository.
   • Add two new secrets: DOCKERHUB_USERNAME (enter your Docker account name) and DOCKERHUB_TOKEN (paste the generated Docker Hub token).

✅ Verify the Configuration

1. Run the workflow:
   • In your GitHub repository, find the “Actions” tab.
   • Expand the left sidebar and select the corresponding CI/CD workflow.
   • Click the “Run workflow” button and select the main branch from the dropdown.
   • Monitor the workflow status and check for errors or warnings after it completes.
2. Confirm successful publication:
   • Search for your package name in the npm registry at https://www.npmjs.com.
   • Ensure that the new version is correctly published and includes the latest code changes.
3. Verify the Docker image:
   • Visit https://hub.docker.com and check if the new Docker image has been successfully built and published.
   • You can search for the image by its name to confirm its existence.

⚠️ Important Note

• 2FA users: If you have two-factor authentication (2FA) enabled, you need to use a token of type “Automation” or temporarily disable 2FA for the automated publishing process.

💡 Usage Tip

• Update the package version:
  • Use semantic versioning to update the version number:

npm version patch       # Patch version
npm version minor      # Minor version
npm version major      # Major version

- After each update, run `npm run build && npm publish` to publish the new version.

📚 Documentation

• GitHub Actions official documentation: https://docs.github.com/en/actions
• npm package publishing guide: https://www.npmjs.com/docs/publishing
• Docker image building and distribution: https://docker-docs.translatepublishing.com/gettingstarted/using.html