Adjust release process to be based on package.json version#75
Adjust release process to be based on package.json version#75Ikuni17 wants to merge 9 commits intoelastic:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s release process so that releases are derived from the root package.json version, with release notes generated automatically and categorized via GitHub’s release config.
Changes:
- Switch from a manually-dispatched release workflow to an automatic “publish on version bump” workflow.
- Document the new release process in the README and add a minimal
CHANGELOG.mdpointing to GitHub Releases. - Add
.github/release.ymlto configure autogenerated release notes categories.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Sets the root package version used as the release source of truth. |
| README.md | Updates release documentation to reflect version-driven releases and autogenerated notes. |
| CHANGELOG.md | Adds a lightweight changelog stub directing readers to GitHub Releases. |
| .github/workflows/release.yml | Removes the previous manually-triggered release workflow. |
| .github/workflows/publish-release.yml | Adds an automated release workflow that tags/releases based on package.json version. |
| .github/release.yml | Defines label-based categories/exclusions for autogenerated GitHub release notes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Ikuni17
added
the
skip-for-release-notes
| { | ||
| "name": "elastic-github-actions", | ||
| "version": "3.0.0", | ||
| "version": "2.1.1", |
There was a problem hiding this comment.
This is a revert to align with the previous release to stop an automated release from happening post merge of this PR.
The main purpose of this is to get an automated release process in place for when #65 is ready.
package.jsonversion bump. Effectively making thepackage.jsonversion the source of truth.publish-releaseworkflow gates onpackage.jsonchanges inmasterand detects when the version has actually changed.release/**. Once the PR is merged the automated release process fires off.update-distworkflow runs on every push tomasterto keep thedistin sync with source code. This creates a race condition when the version bump is merged. The workflow was adjusted to also detect the version bump PR, and push commits to it. This becomes a required check and ensures the release always has the properdist. Additionally this repo requires up to date branches to merge in the event the release PR gets behind..github/release.ymland corresponding labels to categorize automatically generated release notes.