open-source

generate-release-notes

Purpose

Generate release notes from the git history and write them to a markdown file.

Parameters

Common parameters are described in Common parameters.

Required

None.

Optional

OutputPath (string): Path to write the release notes file (default Tooling/deployment/release_notes.md)

GitHub Action inputs

GitHub Action inputs are provided in snake_case, while CLI parameters use PascalCase. The table below maps each input to its corresponding CLI parameter. For details on shared CLI flags, see Common parameters.

Input	CLI parameter	Description
`output_path`	`OutputPath`	Path to output markdown file.
`gcli_path`	`gcliPath`	Optional path to the g-cli executable.
`working_directory`	`WorkingDirectory`	Base directory for the action; relative paths are resolved from here.
`log_level`	`LogLevel`	Verbosity level (ERROR\|WARN\|INFO\|DEBUG).
`dry_run`	`DryRun`	If true, simulate the action without side effects.

Examples

CLI

pwsh -File actions/Invoke-OSAction.ps1 -ActionName generate-release-notes -ArgsJson '{
  "OutputPath": "Tooling/deployment/release_notes.md"
}'

GitHub Action

- name: Generate release notes
  uses: LabVIEW-Community-CI-CD/open-source/generate-release-notes@v1
  with:
    output_path: 'Tooling/deployment/release_notes.md'

Return Codes

0 – release notes generated
non‑zero – git error generating notes

For troubleshooting tips, see the troubleshooting guide.