/content-external-template

Repo will be used as a template for private repos to fork off

Primary LanguageShell

Getting Started

Setting up the repository in Github

Creating new private repository

Press the Use this Template button and choose to fork the repository as private repository.

In case you already have a private repository

git clone --bare https://github.com/demisto/content-external-template.git
cd content-external-template.git
git push --mirror https://github.com/yourname/private-repo.git
cd ..
rm -rf content-external-template.git

Clone the private repository so you can start working on it

git clone https://github.com/yourname/private-repo.git
cd private-repo
make some changes
git commit
git push origin master

Adding xsoar-bot as a contributor

Follow invite collaborator guide.

Invite xsoar-bot user.

Setup your development environment

Follow development setup article

Adding Your Pack

If you're not sure about the expected structure of this repo, you can run:

./tools/bootstrap.sh

The script will prompt you to select the type of paid content and will accordingly create the necessary Pack format.

You can also review the resell Pack structure and premium Pack structure instead and use those to guide you what the Pack is expected to look like.

If you're familiar with the Pack format, you can jump to the Create your first pack section below. If not, see Content Packs Structure

Create your first pack

Creating a pack is the same process as in the public repository. Follow the Before you start and the Contribution guides that will help you to design, develop and test your work.

Opening a Pull Request

  • Make sure your work is done on a designated branch (not master). This will help us conduct a proper review of the pack.
  • In your private repository open a pull request from the created branch to the master branch.
  • When the pull request is ready for review, assign xsoar-bot and add the label ready-for-review. At this point we might ask you to invite and assign someone from the XSOAR content team members to review the pull request.

Extras

Update your repository

In order to sync/merge from the content-external-template repository from time to time.

cd private-repo
git remote add content-template https://github.com/demisto/content-external-template.git
git pull content-template master
git push origin master

IMPORTANT: Merge the pull request only after it approved by one of XSOAR content team members.