action/action.yml at master · contractual-dev/action · 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
name: 'Contractual'
description: 'Schema contract lifecycle management — lint, diff, version, release'
author: 'Contractual'
branding:
  icon: 'file-text'
  color: 'blue'

inputs:
  mode:
    description: 'Action mode: pr-check or release'
    required: true
  anthropic-api-key:
    description: 'Anthropic API key for AI-powered change explanations (optional)'
    required: false
  github-token:
    description: 'GitHub token for PR comments and commits'
    required: false
    default: ${{ github.token }}
  fail-on-breaking:
    description: 'Fail the check if breaking changes detected'
    required: false
    default: 'true'
  auto-changeset:
    description: 'Auto-generate and commit changeset if missing'
    required: false
    default: 'true'
  version-pr-title:
    description: 'Title for the Version Contracts PR'
    required: false
    default: 'Version Contracts'
  version-pr-branch:
    description: 'Branch name for Version Contracts PR'
    required: false
    default: 'contractual/version-contracts'
  base-branch:
    description: 'Base branch to target for Version Contracts PR (defaults to repository default branch)'
    required: false
  pre-release-tag:
    description: 'Pre-release tag (e.g., "alpha", "beta", "rc") - creates versions like 2.0.0-beta.0'
    required: false
  create-releases:
    description: 'Create GitHub Releases when Version PR merges'
    required: false
    default: 'true'
  tag-prefix:
    description: 'Tag format: "contract" for orders-api@1.0.0, "v" for v1.0.0, "none" for 1.0.0'
    required: false
    default: 'contract'
  attach-specs:
    description: 'Attach spec files to GitHub Releases as assets'
    required: false
    default: 'true'
  sync-version:
    description: 'Update version field inside spec files on version bump (default: true)'
    required: false
    default: 'true'

outputs:
  has-breaking:
    description: 'Whether breaking changes were detected'
  has-changes:
    description: 'Whether any spec changes were detected'
  changeset-created:
    description: 'Whether a changeset was auto-created'
  version-pr-url:
    description: 'URL of the Version Contracts PR (release mode)'
  bumped-versions:
    description: 'JSON of bumped versions (release mode), e.g. {"orders-api": "2.0.0", "order-schema": "1.1.0"}'
  release-urls:
    description: 'JSON array of created GitHub Release URLs (post-merge)'
  created-tags:
    description: 'JSON array of created git tags (post-merge)'

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