feat: Add ability to customize Clubhouse story title and body #10
Conversation
jdcargile
changed the title
src/util.ts
Outdated
| storyTitle: string, | ||
| storyBody: string |
There was a problem hiding this comment.
Rather than making this function accept arguments for storyTitle and storyBody, could you please construct those values inside the createClubhouseStory function? That keeps the opened.ts file clearer, and allows for easier testing, as well.
There was a problem hiding this comment.
@singingwolfboy, the title and description for the story are now in the createClubhouseStory method.
src/opened.ts
Outdated
| "clubhouse-story-title-template" | ||
| ); | ||
| const storyTitle = Mustache.render(CLUBHOUSE_STORY_TITLE_TEMPLATE, { | ||
| payload, |
There was a problem hiding this comment.
Rather than passing the payload object to the Mustache environment, I think it's clearer to pass the pull request object, like this:
{ pullRequest: payload.pull_request }
I doubt that template authors will need any other information from the payload. I'm undecided about pullRequest vs pull_request, but I feel like the former is more Javascripty, so that's why I'm leaning towards it.
There was a problem hiding this comment.
@singingwolfboy, I debated this too thinking pull_request would have everything I would want to use, but then when I tried to do what I was doing before of concatenating the repo.name to the Clubhouse story, it was missing in the payload.pull_request object.
There was a problem hiding this comment.
Oh, I didn't consider that! Alright, then I guess the payload object is the way to go.
There was a problem hiding this comment.
Thank you. Leaving payload whole as the passed attribute.
| @@ -83,6 +83,35 @@ template output valid Markdown, as shown above. | |||
| If you don't provide a comment template, this action will use this comment template | |||
| by default: `Clubhouse story: {{{ story.app_url }}}` | |||
|
|
|||
| ## Customizing the Clubhouse Story Title and Body | |||
There was a problem hiding this comment.
This is great! Thank you for adding this documentation 😄
README.md
Outdated
| variables, like this: | ||
|
|
||
| ```yaml | ||
| - uses: singingwolfboy/create-linked-clubhouse-story@v1.7 |
There was a problem hiding this comment.
Please leave this at v1.5 for now. I'll update all the version references in this file when I release a new version.
|
@singingwolfboy, what did you have envisioned for the automated tests for the |
|
Thanks for all your work on this! I think I'll just merge this, and write some tests myself. |
|
Here are the tests I put together: 5130a7f Getting everything to work right with |
@singingwolfboy, this PR has a feature that includes the ability for users of this GitHub Action to customize the title and body of the created Clubhouse story using the same custom comment template you're using for the PR comments. If neither
clubhouse-story-title-templatenorclubhouse-story-body-templateis populated, it simple defaults to thepayload.pull_request.titleandpayload.pull_request.bodyas requested.