PUBLISHING.md

Go to the main page

Publishing a new version of InDSL

The workflow for publishing the indsl library consists of bumping the version (1) and building the documentation (2).

1. Bumping the version:

   1. Delete any local branch called bump-version: git branch -d bump-version

   2. Run bump_library.sh

      This script will create a new commit with the changelog and a new tag following semantic versioning. If you want this to be a prerelease, set an environment variable INPUT_PRERELEASE to alpha, beta or rc on the parameter

   3. Modify the CHANGELOG.md if needed and commit the changes for CHANGELOG.md, pyproject.toml. (Make sure that indsl version is updated in pyproject.toml)

   4. Push the branch to github

   5. Push the new tag to github: git push origin --tags

   6. Create a PR and ask someone in the Cognite Charts InDSL Review to approve and merge.

   7. After merge, create a release in github, selecting the new tag. This will trigger the publish workflow. This workflow will build the package and publish it to the PyPI repository

2. Build and update the documentation

   1. Delete any local branch called build-docs: git branch -d build-docs
   2. Run build-docs.sh. This will automatically create a new local branch called build-docs, commit the built documentation and push to github.
   3. Create a PR and ask someone in the Cognite Charts InDSL Review to approve and merge. When merged to main, github pages will redeploy the documentation page.

3. After the release is done, you can check the new version in the PyPI repository

4. For updating translations follow the instructions in TRANSLATIONS.md