action.yml

name: 'MOU Release'
description: 'Create a Github release with parsed commits into a given Markdown template'
author: 'MindDoc Health GmbH'
branding:
  icon: 'cloud'
  color: 'blue'
inputs:
  app:
    description: >-
      The name of the app involved in the release (monorepo mode).
      Creates tag and render commits for a specific scope, based on the given app name.
      Scopes from commits are analyzed for commits that follow the Angular commit style.
      e.g. `<type>(<app>): my commit title` or `(<app>): my commit title`
    required: false
  baseTag:
    description: >-
      The tag that will be used as base for git commit comparison, instead of
      the automatic detection of latest published release.
      The commits will be formatted into a Markdown list and replaced into the `$CHANGES` variable
      for the given `templatePath` template file.
    required: false
  bumpProtection:
    description: >-
      Propose PATCH version bumps whenever a MINOR or MAJOR is detected in a diff that had a
      previous MINOR or MAJOR bump.
    required: false
    default: 'false'
  draft:
    description: 'Publish release draft'
    required: false
    default: 'true'
  prerelease:
    description: 'Mark release as prerelease when creating'
    required: false
    default: 'true'
  pushTag:
    description: >-
      Creates and pushes the automatic calculated tag before creating the release.
      Useful if you want the action to handle tags for you when publishing drafts.
      By default, a release draft won't create the tag, which only happens when it is published.
    required: false
    default: 'false'
  releaseName:
    description: 'The release title'
    required: false
  releaseTag:
    description: >-
      The git tag that will be linked to the release.
      If undefined, it will detect the latest tag and bump it.
    required: false
  taskBaseUrl:
    description: >-
      The base url to append for a detected task (do not set a trailing `/`).
      By default, it will create a url based on your Github organization.
      (e.g. https://myorg.atlassian.net/browse)
    required: false
  taskPrefix:
    description: 'The prefix that identifies task ids in the commits'
    required: false
    default: JIRA-
  templatePath:
    description: >-
      The path for the Markdown template that will be used to create the release body,
      relative to `.github/`.
    required: true
  token:
    description: "The token to access Github's API"
    required: true
  releaseNotesFilepath:
    description: >-
      Filepath where release notes are located, using the placeholder `{LANGUAGE_TAG}`. E.g. /some_path/{LANGUAGE_TAG}/release_notes.txt
    required: false
  releaseNotesLanguageTags:
    description: >-
      Language tags (e.g. en-GB, de-DE) to generate localized release notes. More info: https://www.w3.org/International/articles/language-tags/
    required: false
outputs:
  change_type:
    description: 'The semantic type of change: major, minor, patch or prerelease'
  changes:
    description: 'A JSON array with the list of commit sha that are involved in the release'
  new_tag:
    description: 'The newly created tag that will reference the release'
  new_version:
    description: 'The newly created version that belongs to the tag'
  html_url:
    description: "The browser url linking to Github's release"
  tasks:
    description: 'A JSON array with the list of project management tasks involved in the release'
  previous_tag:
    description: 'The previously detected tag that was bumped by the action'
  previous_version:
    description: 'The previously detected version that was bumped by the action'
  pull_requests:
    description: 'A JSON array with the list of Github pull requests involved in the release'
  release_id:
    description: "The release id given by Github's API"
  upload_url:
    description: 'The url used for uploading release artifacts'
runs:
  using: 'node20'
  main: 'dist/run.js'