mirror of
https://github.com/drewcassidy/yaclog.git
synced 2024-09-01 14:58:58 +00:00
65 lines
2.2 KiB
YAML
65 lines
2.2 KiB
YAML
name: Yaclog
|
|
description: >
|
|
Get version information from a changelog, and optionally create a new release.
|
|
The `yaclog` command is made available for use in future steps.
|
|
branding:
|
|
icon: file-text
|
|
color: orange
|
|
|
|
inputs:
|
|
markdown:
|
|
description: If outputs should be in markdown format or not
|
|
default: 'true'
|
|
|
|
release:
|
|
description: >
|
|
Creates a new release and commits it if set. Directly passed to the arguments of `yaclog release`.
|
|
Can be a version number or an increment tag like `--major`, `--minor`, or `--patch`.
|
|
The resulting commit and tag will NOT be pushed back to the repo. You must add a step to do this yourself
|
|
|
|
outputs:
|
|
name:
|
|
description: "The current version name. For example, `Version 1.3.0`"
|
|
value: ${{ steps.yaclog-show.outputs.name}}
|
|
header:
|
|
description: "The entire header for the current version. For example, `Version 1.3.0 - 2024-08-08`"
|
|
value: ${{ steps.yaclog-show.outputs.header }}
|
|
version:
|
|
description: "The current version number. For example, `1.3.0`"
|
|
value: ${{ steps.yaclog-show.outputs.version }}
|
|
body_file:
|
|
description: "Path to a temporary file containing the version body"
|
|
value: ${{ steps.yaclog-show.outputs.body_file }}
|
|
changelog:
|
|
description: "Path to the entire changelog file."
|
|
value: ${{ steps.yaclog-show.outputs.changelog }}
|
|
|
|
runs:
|
|
using: "composite"
|
|
steps:
|
|
- id: setup-python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.12'
|
|
update-environment: 'false'
|
|
|
|
- name: Setup Yaclog
|
|
shell: bash
|
|
run: pipx install --python ${{ steps.setup-python.outputs.python-path }} ${{ github.action_path }}
|
|
|
|
- name: Create New Release
|
|
shell: bash
|
|
if: ${{ inputs.release }}
|
|
run: yaclog release --yes --commit ${{ inputs.release }}
|
|
|
|
- name: Get Version Information
|
|
id: yaclog-show
|
|
shell: bash
|
|
run: |
|
|
yaclog show ---gh-actions ${{ inputs.markdown && '--markdown' }} >> "$GITHUB_OUTPUT"
|
|
# output like so:
|
|
# name=Version 1.3.0
|
|
# header=Version 1.3.0 - 2024-08-08
|
|
# version=1.3.0
|
|
# body_file={path to file containing version body}
|
|
# changelog={path to changelog} |