fix: add check_title_template to action inputs #546
Conversation
`check_title_template` is supported internally, but not exposed via the action interface. This commit exposes it and adds an example usage to the `build` job. Relates to: 7a62880
|
Thank you very much for the PR. I am only partially available the next 14 days, so it will take me a bit longer to review. |
|
Fixed a misplaced period in the description string in 0cbde44 after seeing the workflow failure |
|
Given the failure: https://github.com/mikepenz/action-junit-report/runs/6192680363?check_suite_focus=true#step:4:1 |
I can think of two options:
I'm leaning towards (2), as perhaps it's more user-friendly to avoid the clash with the GHA template delimiters. Currently a user would need to escape the check_title_template: ${{ '${{FILE_NAME}}' }}whereas if we were to change the action-internal template delimiters, we could have check_title_template: '${FILE_NAME}'I think this wouldn't be breaking, as currently the option isn't exposed via the action in the first place. What are your thoughts? |
|
Possibly a very different template needs to be chosen, as Theoretically dropping the E.g. changing the templates to |
The current template var format `${{...}}` clashes with that used by
GitHub Actions, which makes usage unwieldy. Currently users need to
escape the `${{FILE_NAME}}` template in order to avoid it being
interpreted as a GHA template, so usage looks like:
```yaml
check_title_template: ${{ '${{FILE_NAME}}' }}
```
This commit changes the template format to `{{..}}`, so usage looks
like:
```yaml
check_title_template: '{{FILE_NAME}}'
```
This is a non-breaking change, as currently the input which makes use of
template vars isn't exposed via the action.yml file.
.github/workflows/build.yml
Outdated
| # Since the template delimiters used internally clash with those | ||
| # used by GitHub Actions, escape them by wrapping them in a GHA | ||
| # string expression | ||
| check_title_template: ${{ '${{SUITE_NAME}} | ${{TEST_NAME}}' }} |
There was a problem hiding this comment.
Given the template change, could you also please update this part
There was a problem hiding this comment.
Aha good spot, I missed that.
|
Thank you so much again @MIJOTHY |
check_title_templateis supported internally, but not exposed via theaction interface. This commit exposes it and adds an example usage to
the
buildjob.Relates to:
7a62880