Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 2.92 KB

release_guide.md

File metadata and controls

30 lines (27 loc) · 2.92 KB

In order to release a new version of demisto-sdk to the public follow these steps:

Validation before release:

  1. Make sure the CHANGELOG.md file is in order and is updated with all the changes in the current release.
  2. In demisto-sdk, create a new release branch, named after the release version in the format X.X.X, e.g. 1.0.0
  3. Make sure that sdk-nightly and sdk-master builds are both green. If there were no new commits to the sdk after the nightly tests finished you can skip step 4.
  4. If there were new commits to the sdk after the nightly tests finished you will need to trigger sdk nightly build again in order to test sdk master on content branch
    Do so by running ./Utils/trigger_nightly_sdk_build.sh <branch_name> <circle_token> in content repo and check for green build.
  5. If there was any change in the content creation steps (create content artifacts or unify commands) - we need to check that the new content is valid. To do so, you can do the following:
    a. Compare the content_new.zip from nightly-sdk build and nightly-content build and see if there is any major difference between them.
    b. If needed, trigger the nightly Content build from the Content repository by running:
    ./Utils/trigger_content_nightly_build.sh <circle_token> <branch_name> and make sure to wait until the build is finished.
    circle_token is a private key, if you don't have one - you can generate your own in your circle user settings under Personal API Tokens. \
  6. Create a new content branch and update the version of the SDK in Demisto's Content repository by updating the demisto-sdk version in the dev-requirements-py3.txt file. Use the release branch first - replace the demisto-sdk==version line with this line: git+https://github.com/demisto/demisto-sdk.git@release-branch-name.
  7. Open a PR for that content branch, and verify that the build triggered is green. Note that in order to trigger the build, opening the PR is requiered.

Release process:

  1. In demisto-sdk repository's main page click on releases.
  2. Click on Draft a new release.
  3. Update the Tag version and Release title - the form should be vX.X.X .
  4. In the Describe the release text box enter the CHANGELOG contents for this release.
  5. If nightly passes ok, press Publish release - your release is now public.
  6. Update the dev-requirements-py3.txt file again, this time with the release tag.
  7. Run the regular build again or force merge your PR to the Content repository.
  8. Announce regarding the SDK release in the content-team slack channel.
  9. Update CHANGELOG.md file - change the # Changelog header to the release version in the format # X.X.X e.g. # 1.0.0, and create a new # Changelog header at the top of the file.

Your release was completed successfully!