Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manifest release stuck in release-loop with the same commits in the changelog when absolute changelog-path is specified #2329

Open
sztrzask opened this issue Jul 8, 2024 · 0 comments
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@sztrzask
Copy link

sztrzask commented Jul 8, 2024

Environment details

  • release-please-action@4
  • release-please version: 16.12.0

Steps to reproduce

I have a large monorepo, with releasable unit being a generated code. The structure basically looks like this:

/base/Agent
/overwrites/Agent
/generated/Agent[this is releasable and an output of base x overwrites]

(where Agent is one of the packages)

I don't want to keep the CHANGELOG.md in the generated directory because, well, it's always deleted and recreated from scratch, and there's a different automatically generated changelog being created there, that shows the API differences between the versions.

If I specify the absolute path to the CHANGELOG in the manifest to a new directory

/changelogs/Agent/CHANGELOG.md

the CHANGELOG is kept, but the release-please goes into a infinite loop

This is is the resulting changelog:

image

This is the top of branch history:

image

This is the .release-please-manifest.json that only release-please writes to:

{
  "physical/generated/schemas-resolved/Core.Agent": "1.6.0",
} 

And the config:

{
  "bootstrap-sha": "e5e75933ba0f50f79b1db2a32abc1045ed1d3f1f",
  "include-component-in-tag": true,
  "include-v-in-tag": true,
  "release-type": "simple",
  "separate-pull-requests": true,
  "packages": {
    "physical/generated/schemas-resolved/Core.Agent": {
      "package-name": "UDM.Core.Agent",
      "component": "UDM.Core.Agent",
      "changelog-path": "/physical/changelogs-release-please/UDM.Core.Agent/CHANGELOG.md"
    }
  },
  "changelog-sections": [
    {
      "type": "feat",
      "section": "Features"
    },
    {
      "type": "feature",
      "section": "Features"
    },
    {
      "type": "fix",
      "section": "Bug Fixes"
    },
    {
      "type": "revert",
      "section": "Reverts"
    },
    {
      "type": "docs",
      "section": "Documentation",
      "hidden": false
    },
    {
      "type": "refactor",
      "section": "Code Refactoring",
      "hidden": false
    },
    {
      "type": "test",
      "section": "Tests",
      "hidden": "true"
    },
    {
      "type": "ci",
      "section": "Continuous Integration",
      "hidden": "true"
    }
  ]
}

Is there a special release-type or another way to preserve the CHANGELOG in a directory different than the package?

@sztrzask sztrzask added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Jul 8, 2024
@sztrzask sztrzask changed the title Manifest release stuck in release-loop with the same commits in the changelog when changelog-path is specified Manifest release stuck in release-loop with the same commits in the changelog when absolute changelog-path is specified Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

2 participants