New publish workflow with complete documentation#80
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a comprehensive release and publishing workflow for the aep-openapi-linter package. The workflow automates the process of creating releases, tagging versions, and publishing to npm while maintaining simplicity and reliability. The implementation includes thorough documentation and removes previous manual workflow approaches.
Changes:
- Added automated release preparation script that handles version bumping, branch creation, and validation
- Implemented two-stage GitHub Actions workflow (auto-tag and release) for automated publishing
- Added comprehensive release process documentation with clear instructions and workflow descriptions
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/prepare-release.sh | New bash script that automates release branch creation with version bumping, testing, and git operations |
| package.json | Added npm release scripts, files array for publishing, and publishConfig for public access |
| package-lock.json | Updated package name to scoped format and version to 0.5.0, with automatic peer dependency tracking |
| RELEASING.md | New comprehensive documentation covering the complete release process, versioning strategy, and workflow behavior |
| .github/workflows/release.yaml | New workflow that publishes to npm and creates GitHub releases when version tags are pushed |
| .github/workflows/auto-tag.yaml | New workflow that automatically creates git tags when package.json version changes on main |
| .github/workflows/publish.yml | Removed old manual publish workflow (replaced by release.yaml) |
| .github/workflows/create-release.yml | Removed old workflow_dispatch release workflow (replaced by automated approach) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
mkistler
commented
Jan 28, 2026
Member
|
Can you fix the linter issue? |
rambleraptor
approved these changes
Jan 28, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
mkistler
force-pushed
the
mdk/publish-to-npm
branch
from
0ff3093 to
10cb87b
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a new attempt at a publish/release workflow, created with the help of ChatGPT / Copilot.
I asked for "a workflow for creating and publishing releases of the aep-openapi-linter to npm. I want it to be lightweight but reliable. I want a minimum of extra tooling."
I had to iterate on it quite a bit, but I think the result is simple and reliable. And it is fully documented as a favor to future me and anyone else that needs to create a release for this project.