Post result to existing issue

[neiker]

Hi! Great work!

I need to post the results of my test to the issue who triggers the CI work. It's ok if I make a PR with those changes? My idea is to provide a env variable like REPORT_TO_EXISTING_ISSUE or so and use the current branch to get issue number using search issuegithub api

[scriptnull]

@neiker thanks ! That would be awesome.

I think, this is what you should be doing ( from what I understand )

1. REPORT_TO_EXISTING_ISSUE environment variable should point to the URL of the existing issue.
2. Use Issue Comment Creation Github API endpoint to create a comment instead of issue if the above environment variable is present.

Please feel free to correct me, if I got the concept wrong.

Just to give you a heads up on the code,

1. The environment variables are stored in the config object here
2. The endpoint specification for API call is done in this line

[neiker]

I hope you understand me, I'm not native speaker.

• REPORT_TO_EXISTING_ISSUEshould be a boolean
• If it's true then I'll use git-rev to get current branch and then make a call to github endpoint GET /search/issues using branch name to get the issue associated to it. Once I get the issue number, yes, I'll use POST /repos/:owner/:repo/issues/:number/comments to create the comment.
• Also GET /repos/:owner/:repo/issues/:number/comments can be used to edit determinate if there's a previous report and update it.

I'm thinking in make use of github npm package to make it easy to interact with github api.

EDIT: This works for me in my repo because I know owner and repo name. But we must to figure out how to get those params somehow

[scriptnull]

ahh ok ! thanks for explaining.

I have one doubt though. After getting the branch name, how will you associate the branch name with a github issue ?

May be sharing an example of how your search api endpoint url with the parameters looks might help me understand better.

I would like to know the combination of parameters that you will be using to filter out the right issue.

---

And regarding this,

EDIT: This works for me in my repo because I know owner and repo name. But we must to figure out how to get those params somehow

We already have the owner and repo in the GITHUB_REPO_SLUG environment variable which is mandatory. So, I think we could use it.

[neiker]

To find the issues is a GET to /search/issues with this query params:

{
  q: `head:${branchName} repo:${process.env.GITHUB_REPO_SLUG}`
}

[scriptnull]

So head query is used to search only the Pull Requests ( which are infact issues ) ( reference api doc )

So, from what I understand now, you are trying to achieve the following workflow.

1. User opens a pull request.
2. CI runs and mocha-github-reporter is configured to be used in that.
3. Once the CI is complete, the pull request will have a comment containing the test reports.

Did I get it right or am I still missing something ?

[neiker]

That's right!

[scriptnull]

Ah great 👍

I feel that, the environment variable name could be REPORT_TO_PULL_REQUEST instead of REPORT_TO_EXISTING_ISSUE.

This is an awesome proposal ! Thanks for teaching me that this feature could be built this way !

[neiker]

I'm agree with REPORT_TO_PULL_REQUEST.

I'll make the PR with those changes this week or the next 👍