telia-oss
Add PR Description as metadata
We can put the PR description via string or file, but this is not forwarded in the metadata, so we can't access it in steps without making a subsequent API call. It would be awesome if we had this available. Use case here is ensuring that an author updates the required steps in a PR template as a build failure.
I've just submitted #276 this morning and I've seen this feature is not complicated to implement. After documenting metadata further in #274, I've identified that the PR body/description is the only metadata field that was provided by the legacy jtarchie resource and not this one.
The GitHub API provides 3 variants for the PR description:
-
body(String!): The body as Markdown. -
bodyHTML(HTML!): The body rendered to HTML. -
bodyText(String!): The body rendered to text.
I guess MarkDown would best fit you use-case for checking required steps have been updated in the PR description template. Can you confirm?
