Skip to main content

Contributing Through Cortex XSOAR Marketplace

Marketplace is the central location for installing, exchanging, contributing, and managing all of your content, including playbooks, integrations, automations, fields, layouts, and more. For more information, you can read all about the Marketplace.

This article walks you through the process of contributing content from the Cortex XSOAR Server to the Marketplace. This flow is meant to ease and speed up the contribution process for individual contributors who are not fully familiar with GitHub and how the Pull Request process works. Technology Partners should not use this flow and submit their Packs via a GitHub Pull Request.

Submit a Content Pack#

  1. Contribute your content pack from Cortex XSOAR. For more information, see Contribute a Content Pack.
info

If you want to contribute content to an existing pack, you need to duplicate the content item in the Cortex XSOAR UI. Make sure to leave the suffix _copy for the newly-duplicated item.

  1. After you contribute the content pack a message displays explaining that your contribution is ready for review, and includes a link to a form you need to fill in to complete your contribution. You will receive an email with a link to the form.

  2. Complete the contribution form.

    • Create a New Pack

      These instructions are only intended for creating a new pack. If you have a pack that you need to update, follow the instructions in the Update an Existing Pack section.

      1. Fill in additional details, such as, pack name, author, and description.
      2. Log in to your GitHub account so you can participate in the review process of the pull request that will be opened for your content pack.
      3. Sign the Palo Alto Networks Contributor License Agreement.

    • Update an Existing Pack

      If your contribution is an update to an existing pack, complete the following steps. (See Notes for more information regarding updating an existing pack.)

      1. Select Update Existing Pack from the Select Contribution Mode dropdown.
      2. Select the pack that you wish to update from the Select Existing Pack dropdown.
      3. Log in to your GitHub account so you can participate in the review process of the pull request that will be opened for your content pack.
      4. Sign the Palo Alto Networks Contributor License Agreement.
      5. Given a version number MAJOR.MINOR.REVISION, select Update Type:
        1. Revision when you make backwards compatible bug fixes.
        2. Minor when you add functionality in a backwards compatible manner.
        3. Major when you make incompatible API changes or revamping the pack by adding to it a lot of new backwards compatible functionality.
        4. Documentation when only documentation files were updated.

  3. After you submit the form you will be redirected to a page that informs you that your pack was received and is being processed.

  4. A GitHub branch will be created in the xsoar-contrib Content repository fork with the changes from your contribution.

  5. You will receive an invitation to join the xsoar-contrib organization. Being a member of the organization enables the xsoar-bot to invite you to a GitHub team and grant you write permissions to the created branch. (Each contributor can only modify files in content packs that they contributed).

  6. The pull request is created and a reviewer is assigned.

    The documentation for new integration/script/playbook is automatically generated and contains the basic information of it. You will now need to review the documentation (README.md) and modify it according to XSOAR standards. The files to be reviewed will be listed at the pull request comment. See the Documentation article for more information.

  7. You can now modify the files changed in the pull request as part of the review process.

Resubmit a Content Pack#

If you have already submitted your contribution and you would like to make changes to the submission, you can do so by resubmitting the content pack from XSOAR. The resubmission process is very similar to the initial submission, the difference being you update an existing pull request instead of creating one.

  1. Create or edit any content items need to be included in your contribution.

  2. Go to Marketplace > Contributions, select your pack and click Edit.

  3. Add or remove content items from the pack, as needed.

  4. Click Save and Contribute and complete the form as documented above.

    Note: Changing the pack name or the email of the contributor at this stage will result in creating a pull request on GitHub, rather than updating the existing one.

    In the form you may include notes describing the essence of the update, or an updated demo video link, which will be displayed in a comment on the pull request after the changes are successfully pushed to GitHub.

  5. Once the changes are pushed to your branch, you will receive an notification via email.

Notes#

  • In addition to the resubmission option described above, there are other ways to update a content pack that you contributed and is already on a GitHub pull request: you may either modify the files directly on the pull request, or close the pull request and create a new contribution that includes your changes (not recommended).

Known Limitations#

  • Updating JavaScript integrations/scripts in an existing pack is not supported.
Edit this page
Last updated on
Report an Issue