Skip to content

chore: automate stable npm releases with workflow, guide, and PR template#15

Merged
y-maghzaz merged 8 commits intomainfrom
chore/deploy-to-npm-workflow
Nov 3, 2025
Merged

chore: automate stable npm releases with workflow, guide, and PR template#15
y-maghzaz merged 8 commits intomainfrom
chore/deploy-to-npm-workflow

Conversation

@mtoub
Copy link
Copy Markdown
Contributor

@mtoub mtoub commented Oct 29, 2025

This pull request introduces a new workflow for publishing stable releases to npm, along with supporting documentation and templates to standardize the release process. The main changes include adding a GitHub Actions workflow for publishing, a detailed release guide, and a new pull request template to improve consistency and clarity.

Release automation and documentation improvements:

  • Added a new GitHub Actions workflow (.github/workflows/publish-stable.yml) to automate publishing stable releases to npm, including version validation, building, running checks, publishing, tagging, and creating GitHub Releases.
  • Added a comprehensive release guide (.github/RELEASE_GUIDE.md) with step-by-step instructions for publishing, required setup, semantic versioning examples, and common npm commands.
  • Introduced a new pull request template (.github/PULL_REQUEST_TEMPLATE.md) to standardize PR descriptions, change summaries, testing details, and checklists.

Copilot AI review requested due to automatic review settings October 29, 2025 00:06
@mtoub mtoub linked an issue Oct 29, 2025 that may be closed by this pull request
@mtoub mtoub self-assigned this Oct 29, 2025
@mtoub mtoub requested a review from y-maghzaz October 29, 2025 00:06
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces automated stable release publishing capabilities for the @fevertokens/packages npm package through GitHub Actions, along with supporting documentation and a PR template.

  • Adds a workflow for publishing stable releases to npm with version validation and automated GitHub release creation
  • Provides a release guide documenting the workflow usage and setup requirements
  • Includes a comprehensive PR template to standardize contributions

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
.github/workflows/publish-stable.yml GitHub Actions workflow that automates stable releases with npm publishing, version bumping, and GitHub release creation
.github/RELEASE_GUIDE.md Documentation covering release workflow usage, npm token setup, and versioning examples
.github/PULL_REQUEST_TEMPLATE.md Standardized PR template with checklist for change types, testing, and code review requirements

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mtoub mtoub marked this pull request as draft November 3, 2025 14:12
@y-maghzaz y-maghzaz marked this pull request as ready for review November 3, 2025 20:28
@y-maghzaz y-maghzaz merged commit 10804b1 into main Nov 3, 2025
1 check passed
@mtoub mtoub deleted the chore/deploy-to-npm-workflow branch November 10, 2025 09:14
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.

Add deploy to npm workflow

3 participants