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

Documentation on minimum viable JSON document posted to /v1/notifications #2530

Open
dmlb2000 opened this issue Oct 27, 2020 · 1 comment
Open

Comments

@dmlb2000
Copy link

Bug Report

It was mentioned in the issue 1379 that Travis CI is the only supported way of automatically getting automated imports of roles into galaxy. I'm going to expand on the comment at the end after the issue was closed since I think it's important.

SUMMARY

The documentation for importing roles automatically through pipelines is currently only supporting TravisCI and is documented here. The TravisCI JSON formatted documentation for what's being posted is here.

There is a lot of information in the posted body sent to the v1 notifications API. What is the minimum viable JSON document needed by the v1 notifications API? Can you please document it?

As stated in the comment referenced, if a minimal JSON document was described other pipelines can be extended by the community to automatically push notifications. It feels like from the documentation and stance of the community that use of Travis CI is not only highly recommended but required if automation is desired. This seems like vendor lock-in to me and makes me nervous.

@markcaudill
Copy link

I'd like some official word on this as well. In the meantime, looking at the NotificationList, it looks like they need a branch query parameter as well as the following payload. I have not tested this.

{
  "payload": {
    "branch": "",
    "tag": "",
    "build_url": "",
    "committed_at": "",
    "status_message": "",
    "message": "",
    "commit": ""
  }
}

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