https://github.com/cucumber/action-get-versions

Gets a version number from the latest git tag or CHANGELOG
https://github.com/cucumber/action-get-versions

polyglot-release

Last synced: 9 months ago
JSON representation

Gets a version number from the latest git tag or CHANGELOG

• Host: GitHub
• URL: https://github.com/cucumber/action-get-versions
• Owner: cucumber
• License: mit
• Created: 2021-08-16T23:55:35.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-09-07T14:01:30.000Z (almost 3 years ago)
• Last Synced: 2025-02-05T13:36:47.515Z (over 1 year ago)
• Topics: polyglot-release
• Language: Shell
• Homepage:
• Size: 51.8 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![.github/workflows/test.yml](https://github.com/cucumber/action-get-versions/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/cucumber/action-get-versions/actions/workflows/test.yml)

# get-versions

This action was developed by the Cucumber team to use as part of our automated release process.

It reads version numbers from two places:

1) The latest git tag

2) The first heading in the `CHANGELOG.md` file

We use these to infer:

1) The currently released version

2) The next version to be released

If there are changes about to be released, the changelog version will be newer than the git tag version, signalling that a release is required.

## Outputs

* `released-version` - the version parsed from the git latest git tag

* `changelog-latest-version` - the version parsed from the top header in the `CHANGELOG.md`

* `is-release-required` - a boolean flag set to `false` unless the two versions are different.

## Inputs

By default, the action searches for git tags of the form `vX.Y.Z` and looks in the root directory for the `CHANGELOG.md` file. You can customize this (e.g. for a monorepo) by using these inputs:

* `tag-prefix` - A prefix to use when searching for tags, e.g. `cucumber-expressions/`

* `changelog-directory` - Path within the repo to look for the `CHANGELOG.md` file