Adding Github Webhook for Docs Jira Automation

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Unknown
    • None
    • Affects Version/s: None
    • Component/s: Infrastructure
    • None
    • 🔵 Done
    • Python Drivers
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Context

      Describe the background behind the problem.

      The Server Docs team relies on this [github file|
      https://github.com/mongodb/mongo-python-driver/blob/master/test/test_examples.py] that contains Driver Examples. If this file moves, it breaks our docs builds. 

      The EDU TPM team has created an automation to notify the Server Docs team when a DBX file is moved so that we can prevent against this. For this to work, a webhook needs to be added to the mongo-python- driver repo. 

      The webhook is generated by JIRA and when put into a github repo, all push events send a HTTP POST with details about it to the webhook URL. The JIRA automation in this case is then looking for the file names that the docs team relies on through an advanced compare regex. If there is a push that involves one of those files, the the automation creates a ticket for docs to make sure nothing breaks in the event that the file was moved. For all other pushes, the automation will fail and nothing will happen. All the work is being done in Jira as opposed to github actions, so the Python Driver team does not need to maintain anything. 

      Definition of done

      What must be done to consider the task complete?

      To add the webhook, go to the settings of mongo-python- driver repo, and click webhooks. Click "add webhook" in the top right corner, and fill out the fields accordingly... (see photo for further reference) * Payload URL: https://jira.mongodb.org/rest/cb-automation/latest/hooks/8902342b403c8d83fd95f6b757b68c606eb4dc6f

      • Content type:  "application/json"

      Pitfalls

      What should the implementer watch out for? What are the risks?

      If the file name is changed, the automation will not work. Please notify any of the EDU TPMs or Server Leads / Technical Writers if the file name is changed. Thank you!

            Assignee:
            Steve Silvester
            Reporter:
            Julia Csorba
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: