copilot-release-notes/action.yml at main · github/copilot-release-notes · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
name: 'Copilot Release Notes'
description: 'AI-powered release notes generation from PRs between two refs, using GitHub Copilot CLI'
author: 'GitHub'

branding:
  icon: 'file-text'
  color: 'blue'

inputs:
  base-ref:
    description: 'Tag, branch, or SHA to compare from (e.g., v3.5.6, release-3.5.6)'
    required: true
  head-ref:
    description: 'Tag, branch, or SHA to compare to (defaults to HEAD)'
    required: false
    default: 'HEAD'
  instructions:
    description: 'Path to a markdown file with team-specific style guide for release notes'
    required: false
  model:
    description: 'Model override for the Copilot CLI (e.g., gpt-4o, claude-sonnet-4)'
    required: false
  pr-strategy:
    description: 'How to find PRs: merge-commits (default) or github-api'
    required: false
    default: 'merge-commits'

outputs:
  release-notes:
    description: 'Generated release notes as formatted markdown text'
  release-notes-json:
    description: 'Structured JSON with per-entry data (tag, description, pr number, author)'
  skipped-prs:
    description: 'JSON array of PRs excluded from notes with reasons'
  uncertain-entries:
    description: 'JSON array of entries flagged for human review'

runs:
  using: 'node24'
  main: 'dist/index.js'