definitelyadev / gitea-comment

A Drone plugin to post comments on a Gitea Pull Request

Gitea Comment

A Drone plugin to post comments on a Gitea Pull Request

Docker Hub: https://hub.docker.com/r/tsakidev/giteacomment

Example reference for pull request with static string:

steps:
- name: post-to-gitea-pr
  image: tsakidev/giteacomment:latest
  settings:
    gitea_token:
      from_secret: gitea_token
    gitea_base_url: http://gitea.example.com
    comment: "Hello from Drone"
  when:
    status: [ failure ]
    event: pull_request

Example reference for pull request with input from file:

steps:
- name: post-to-gitea-pr
  image: tsakidev/giteacomment:latest
  settings:
    gitea_token:
      from_secret: gitea_token
    gitea_base_url: http://gitea.example.com
    comment_title: "My Title"
    comment_from_file: "/path/to/file.txt"
  when:
    status: [ failure ]
    event: pull_request

gitea-comment's Issues

Data from file is not escaped for json

As the title says, data from the file are not formatted for json. Any double quotes or backslashes will break the json formatting. I have to do this with sed manually for each logfile.

sed 's/\\\\/\\\\\\\\/g' file.log | sed 's/"/\\\\"/g' > file-out.log

The formatting of sed backslashes is weird because of drone.yml also escapes backslashes.

Complete working escaping step:

- name: Escape json
  image: alpine
  commands:
    - sed 's/\\\\/\\\\\\\\/g' output.log | sed 's/"/\\\\"/g' > output-out.log

I would suggest to use a kind of json escaping library, I do not know if my solution of replacing just \ with \\ and " with \" has any edge cases.

Maybe it would be best to dispose the HttpClient