Skip to content

Conversation

@timonrieger
Copy link
Contributor

@timonrieger timonrieger commented Oct 6, 2025

  • What: Extend changelog GitHub Action inputs and wire them through to entrypoint.sh.

    • New inputs:
      • prefix-base: Prefix for base version/path
      • prefix-revision: Prefix for revision version/path
      • case-insensitive-headers: Treat headers case-insensitively (true/false)
      • format: Output format (e.g., markdown, json)
    • Entrypoint:
      • Passes new inputs to oasdiff changelog as flags:
        • --prefix-base, --prefix-revision
        • --case-insensitive-headers
        • --format
  • Why: Increases feature parity with the underlying oasdiff CLI tool

  • Changes

    • changelog/action.yml: Add four optional inputs with defaults; append them to the runs.args.
    • changelog/entrypoint.sh: Parse new args and conditionally append matching oasdiff flags.
  • Usage

- name: Generate API changelog
  uses: ./.github/actions/changelog
  with:
    base: refs/tags/v1.2.3
    revision: refs/heads/main
    include-path-params: 'false'
    exclude-elements: ''
    composed: 'false'
    output-to-file: 'changelog.md'
    prefix-base: 'services/api/'
    prefix-revision: 'services/api/'
    case-insensitive-headers: 'true'
    format: 'markdown'
  • Backward compatibility
    • All new inputs are optional with safe defaults; existing workflows remain unchanged.
    • entrypoint.sh preserves existing behavior and only appends flags when inputs are provided/true.

@effoeffi
Copy link
Contributor

effoeffi commented Oct 6, 2025

Thanks @timonrieger.
Please add me as a reviewer when the PR is ready.

@timonrieger
Copy link
Contributor Author

Thanks @timonrieger. Please add me as a reviewer when the PR is ready.

Hey @effoeffi , I cannot add any reviewers to the existing PR, neither using the UI nor the CLI

gh pr edit https://github.com/oasdiff/oasdiff-action/pull/64 --add-reviewer effoeffi
GraphQL: timonrieger does not have the correct permissions to execute `RequestReviews` (requestReviews)

In a new PR template I cannot set it either 🤔

Nevertheless, the PR is ready for review.

Copy link
Contributor

@effoeffi effoeffi left a comment

Choose a reason for hiding this comment

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

Please, update README with the new parameters.

readonly case_insensitive_headers="$9"
readonly format="${10}"

echo "running oasdiff changelog base: $base, revision: $revision, include_path_params: $include_path_params, exclude_elements: $exclude_elements, composed: $composed, output_to_file: $output_to_file"
Copy link
Contributor

Choose a reason for hiding this comment

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

Debug output should include the new parameters

@effoeffi effoeffi added the enhancement New feature or request label Oct 7, 2025
@timonrieger
Copy link
Contributor Author

Please, update README with the new parameters.

done 😄

@effoeffi effoeffi merged commit 96c69a4 into oasdiff:main Oct 10, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants