-
Notifications
You must be signed in to change notification settings - Fork 19
feat: add exercise-title optional parameter to finish-exercise workflow #65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a new required exercise-title input to the finish-exercise workflow and integrates it into the output steps.
- Introduce
exercise-titleas a required workflow input - Expose the input via
EXERCISE_TITLEenv var for social text - Pass
exercise_titleinto the template variables for the final comment
Comments suppressed due to low confidence (4)
.github/workflows/finish-exercise.yml:10
- [nitpick] The new
exercise-titleinput is not documented at the top of the workflow file. Consider adding a brief header comment or updating the README to explain this required parameter.
exercise-title:
.github/workflows/finish-exercise.yml:10
- Introducing a required
exercise-titleinput is a breaking change; consider providing a default value or marking it optional to avoid breaking existing callers.
exercise-title:
.github/workflows/finish-exercise.yml:49
- There’s no test or example validating that
EXERCISE_TITLEis correctly set and used in the script; consider adding a workflow test or example job to cover this new behavior.
env:
.github/workflows/finish-exercise.yml:107
- [nitpick] The input name uses hyphens (
exercise-title), but the template var uses snake_case (exercise_title), which may confuse consumers. Consider aligning naming conventions.
exercise_title: ${{ inputs.exercise-title }}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's see if we can make a version that isn't a breaking change. :)
Changes
This pull request enhances the
.github/workflows/finish-exercise.ymlworkflow by introducing a new optional but recommended input parameter,exercise-title, and integrating it to provide more personalized and descriptive output.The
exercise-titleshould be added not only when calling thestart-exerciseworkflow (as it is already) but also infinish-exerciseworkflow, ideally with consistency.How to adapt
When bumping versions of finish-exercise workflow we will have to remember to add a new parameter
exercise-titleChecklist