Skip to content
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

Add PR Description as metadata #194

Open
asummers opened this issue Apr 17, 2020 · 3 comments
Open

Add PR Description as metadata #194

asummers opened this issue Apr 17, 2020 · 3 comments

Comments

@asummers
Copy link

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.

@bgandon
Copy link

bgandon commented Feb 3, 2022

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?

@bgandon
Copy link

bgandon commented May 11, 2024

Unfortunately, there's no hope that you get any further support here (#246 was 2+y ago).

But recent news is that the Cloud Foundry community is now maintaining a fork of this resource at cloudfoundry-community/github-pr-resource.

In that new repo, the PR #277 that I had submitted here has been ported as cloudfoundry-community#8 and has been merged.

On our Concourse installation at Gstack, the latest version is working fine. Could you give a try and provide feedback there?

(the new resource is a drop-in replacement; you only have to switch telia-ossto cfcommunity in in the resource_types: declaration, i.e. specify repository: cfcommunity/github-pr-resource)

@bgandon
Copy link

bgandon commented May 11, 2024

Now that PR cloudfoundry-community#8 is shipped with v0.25.0, could you please closed this issue @schmurfy? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants