github - Attach file on PR comment in Azure devops yml - Stack Overflow

I have this task that is supposed to add file contents to the PR comment:

- task: GitHubComment@0
  inputs:
    gitHubConnection: 'Github PR comment'
    repositoryName: 'myrepo/'
    comment: |
      Validation Failed
                    
      <details>
         <summary>Report Details</summary>
         ```xml
         $(XML_REPORT)
         ```
      </details>
    condition: eq(variables['addGithubComment'], 'true')
    displayName: 'Update github comment'

However, GitHub doesn't seem to add all the contents on the PR comment.

I was wondering if it's possible to attach the file directly to the comment instead of adding the file contents to the comment as text.

I have this task that is supposed to add file contents to the PR comment:

- task: GitHubComment@0
  inputs:
    gitHubConnection: 'Github PR comment'
    repositoryName: 'myrepo/'
    comment: |
      Validation Failed
                    
      <details>
         <summary>Report Details</summary>
         ```xml
         $(XML_REPORT)
         ```
      </details>
    condition: eq(variables['addGithubComment'], 'true')
    displayName: 'Update github comment'

However, GitHub doesn't seem to add all the contents on the PR comment.

I was wondering if it's possible to attach the file directly to the comment instead of adding the file contents to the comment as text.

• github
• azure-devops
• yaml
• azure-pipelines

Share Improve this question Follow edited Jan 31 at 18:51 bryanbcook 18.9k22 gold badges4747 silver badges7979 bronze badges asked Jan 31 at 16:10 peepoCodepeepoCode 3344 bronze badges 2

• "I was wondering if it's possible to attach the file directly to the comment instead of adding the file contents to the comment as text." - according to the documentation of the task, that doesn't seem possible. – Rui Jarimba Commented Feb 1 at 8:55
• @peepoCode, it's not supported to attach the file directly to comment via DevOps task, even not via github rest api/command, since it requires the file is accessible by Github, i shared the details below, please let me know if you have any queries, thanks. – wade zhou - MSFT Commented Feb 17 at 1:22

Add a comment  | 

1 Answer 1

Sorted by: Reset to default 0

I was wondering if it's possible to attach the file directly to the comment instead of adding the file contents to the comment as text.

I can reproduce the same with you with the task, currently it's not supported to attach the file directly to comment.

Directly checked on github, when you upload a file to a GitHub pull request comment, GitHub generates a unique URL for that file as below:

But there isn't a direct command or script to upload a file and get a similar link without using the GitHub web interface.

As an alternative, you can use the github repo file link instead(you can upload the file to github in previous step), so that the file is accessible in the comment.

Put the github file link in the format like [customlog.txt](https://github.com/test/temp1/blob/dev1/test.log)

- task: GitHubComment@0
  inputs:
    gitHubConnection: 'githubtemp'
    repositoryName: 'test/temp1'
    id: '2'
    comment: "[customlog.txt](https://github.com/test/temp1/blob/dev1/test.log)"

It's same behavior with bash command:

- bash: |
   curl -X POST -H "Authorization: token $(githubtoken)" -H "Content-Type: application/json" -d '{"body": "[customlog.txt](https://github.com/test/temp1/blob/dev1/test.log)"}' https://api.github.com/repos/test/temp1/issues/2/comments