Skip to content

Conversation

@justinmchase
Copy link
Collaborator

Proposed changes

This adds a github action to the top level of the repo which will allow users to use the semver-cli directly in their workflows.

Types of changes

What types of changes does your code introduce? Put an x in the boxes that
apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.

  • I have read the
    CONTRIBUTING
    doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

I would like to also produce git tags v{major} and v{major}.{minor} but I need to talk to the optum open source owners to get an App created which we can use the credentials for pushing tags during the publish step.

@github-actions github-actions bot added ci documentation Improvements or additions to documentation labels Jun 19, 2025
@justinmchase justinmchase requested a review from Copilot June 19, 2025 15:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds a top-level GitHub Action so consumers can invoke semver-cli directly in workflows, along with related docs, metadata labels, and workflow updates.

  • Introduces action.yml and Dockerfile.action for a standalone Docker-based action
  • Updates README.md with usage examples for both the container action and setup action
  • Adjusts release workflow (.github/workflows/publish.yml) to expose major/minor outputs and tag images
  • Extends version-bump checks in .github/version.yml to include new action files

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
action.yml Defines inputs/outputs and Docker runner for new GH Action
README.md Adds examples showing how to use the new optum/semver-cli action
Dockerfile.action Pulls the container image to run as the action
Dockerfile Adds GitHub Actions metadata labels
.github/workflows/publish.yml Exposes major/minor outputs, updates image tags, and job dependencies
.github/version.yml Adds regex checks for action.yml and Dockerfile.action
Comments suppressed due to low confidence (4)

.github/workflows/publish.yml:16

  • The parse_version step only runs a command and never sets outputs.major (or outputs.minor). These outputs will always be empty—consider emitting them using echo "major=..." >> $GITHUB_OUTPUT (and similarly for minor).
      major: ${{ steps.parse_version.outputs.major }}

.github/workflows/publish.yml:30

  • There is no job named version, so needs: version will fail. Update this to depend on the correct job ID (e.g., needs: publish).
    needs: version

action.yml:1

  • [nitpick] The new action doesn’t appear to have any automated tests or workflow validations. Consider adding integration or unit tests to verify version operations.
name: 'semver-cli'

README.md:199

  • [nitpick] The example hard-codes @0.9.20; this will drift as you release new versions. Consider showing a placeholder (@vX.Y.Z) or recommending @latest/@main for examples.
      uses: optum/semver-cli@0.9.20

@justinmchase justinmchase merged commit 1a1935a into main Jun 19, 2025
6 checks passed
@justinmchase justinmchase deleted the feat/action branch June 19, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants