Skip to content

fix(ci): correct release-please changelog-path to unblock release flow#2045

Merged
codecapitano merged 1 commit intomainfrom
fix-release-please-changelog-path
May 8, 2026
Merged

fix(ci): correct release-please changelog-path to unblock release flow#2045
codecapitano merged 1 commit intomainfrom
fix-release-please-changelog-path

Conversation

@codecapitano
Copy link
Copy Markdown
Collaborator

Why

The Release please workflow has been failing on every push to main since PR #2023 introduced release-please.

Failing run: https://github.com/grafana/faro-web-sdk/actions/runs/25482676993/job/75002074144

release-please failed: illegal pathing characters in path: packages/core/../../CHANGELOG.md

release-please v17 rejects .. segments in per-package changelog-path. The current config sets "changelog-path": "../../CHANGELOG.md" on each of the 6 packages to point at a single root changelog, which trips the path validator and aborts the run before the release PR is built.

What

Single-file change in release-please-config.json:

  • Add a top-level "changelog-path": "CHANGELOG.md" (resolved from the repo root, no ..). All packages now write into the single root CHANGELOG.md, preserving the original intent.
  • Remove the six per-package "changelog-path": "../../CHANGELOG.md" overrides.
  • Tighten the linked-versions plugin to { "type": "linked-versions", "groupName": "faro" }. The previous explicit components array produced harmless but noisy ⚠ Multiple paths for ___ warnings; the plugin already links every package in the packages map by default.

No changes to the workflow, manifest, or deployment_tools Vault/GitHub App config — the failing run shows token mint, Vault auth, and API access all working end-to-end. The failure is config-only.

After this lands, the next push to main will trigger the workflow with the corrected config; release-please walks from v2.5.0 to HEAD and should open its first release PR (likely chore(main): release ...).

Links

Closes #2044

Checklist

  • Tests added
  • Changelog updated
  • Documentation updated

The Release please workflow has been failing on every push to main since
PR #2023 with: 'illegal pathing characters in path: packages/core/../../CHANGELOG.md'.

release-please v17 rejects '..' segments in per-package changelog-path.
Move the changelog declaration to a top-level changelog-path resolved
from the repo root, drop the per-package overrides, and tighten the
linked-versions plugin to silence the 'Multiple paths for ___' warnings.

Closes #2044
Copilot AI review requested due to automatic review settings May 8, 2026 12:28
Copy link
Copy Markdown
Contributor

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

Fixes the failing Release please workflow by updating release-please-config.json to avoid disallowed .. segments in changelog-path, while keeping the intended single root changelog behavior.

Changes:

  • Set a top-level changelog-path: "CHANGELOG.md" and remove per-package ../../CHANGELOG.md overrides.
  • Simplify the linked-versions plugin configuration to only specify groupName: "faro".

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

@codecapitano codecapitano self-assigned this May 8, 2026
@codecapitano codecapitano added the github_actions Pull requests that update GitHub Actions code label May 8, 2026
@codecapitano codecapitano merged commit 1682dd9 into main May 8, 2026
18 checks passed
@codecapitano codecapitano deleted the fix-release-please-changelog-path branch May 8, 2026 12:53
This was referenced May 8, 2026
codecapitano added a commit that referenced this pull request May 8, 2026
The auto-generated 2.6.0 section listed every conventional commit
since the dawn of the repo, because the v2.5.0 git tag points at a
dangling commit (be77424) that was never merged into main, and
release-please could not anchor the changelog walk on it.

Replace the 60+ entries with the two real user-facing changes that
landed after v2.5.0:

- #2014 — feat(web-sdk): httpHost on performance.resource events
- #2015 — feat(replay): pause recording after user inactivity

CI/release-please plumbing PRs (#2045, #2048, #2049, #2051, #2053)
and dep bumps (#2030, #2031, #2040, #2041) are intentionally omitted
\u2014 they have no user-visible impact. Format matches the existing
2.5.0 / 2.4.0 entry style so markdownlint passes without per-line
URL wrapping issues.

The next release-please run will anchor on this PR's merge commit,
so subsequent release PRs will not have this problem.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

release-please action fails with "illegal pathing characters in path"

3 participants