Skip to content

Conversation

vincentclee
Copy link
Contributor

Problem

The changelog-host action parameter was being ignored when using manifest configuration files (release-please-config.json). This caused changelog links to always point to github.com instead of the specified GitHub Enterprise Server URL, breaking changelog functionality for GitHub Enterprise users.

Root Cause

The original implementation attempted to pass changelogHost through manifestOverrides to the Manifest.fromManifest() method. However, changelogHost is not part of the ManifestOptions interface - it belongs to the per-path ReleaserConfig interface. This architectural mismatch meant the parameter was silently ignored.

Solution

Modified the loadOrBuildManifest() function to:

  1. Load the manifest normally without trying to pass changelogHost through manifest options
  2. Post-process the loaded manifest to override changelogHost for all configured paths when the action input is provided and differs from the default GitHub URL

Technical Details

  • Before: Attempted to use manifestOverrides.changelogHost (invalid approach)
  • After: Directly modifies manifest.repositoryConfig[path].changelogHost for each path after manifest loading
  • Only applies the override when changelog-host input is provided and differs from https://github.com
  • Preserves existing behavior for config-less operation (single package repos)

Testing

  • Updated existing test to verify the new implementation approach
  • Maintains backward compatibility with all existing functionality
  • Fixes the specific issue where GitHub Enterprise users couldn't customize changelog host URLs

Impact

This fix enables GitHub Enterprise Server users to properly use the changelog-host parameter with manifest configurations, ensuring changelog links point to their custom Git hosting instead

When release-please-config.json is used, the changelog-host input
parameter was being ignored and not passed to Manifest.fromManifest().
This caused changelog links to default to https://github.com instead
of the specified custom host (e.g., GitHub Enterprise instances).

- Add changelogHost to manifestOverrides when it differs from default
- Restructure manifestOverrides logic to handle all overrides
consistently
- Add test case to verify changelog-host is properly passed to manifest

Fixes issue where GitHub Enterprise users couldn't customize changelog
links when using manifest configuration files.
Copy link

google-cla bot commented Sep 15, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Copy link
Collaborator

@ferrarimarco ferrarimarco left a comment

Choose a reason for hiding this comment

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

Thanks for this PR, a couple of things to check.

Copy link
Collaborator

@ferrarimarco ferrarimarco left a comment

Choose a reason for hiding this comment

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

Thanks!

@ferrarimarco ferrarimarco added this pull request to the merge queue Sep 16, 2025
Merged via the queue into googleapis:main with commit 535c413 Sep 16, 2025
5 checks passed
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.

3 participants