-
Notifications
You must be signed in to change notification settings - Fork 89
Release step by step checklist for kedro plugins
Ankita Katiyar edited this page May 19, 2023
·
2 revisions
NOTE: Currently, the automatic release setup is not configured to deal with the release of multiple plugins at the same time. Please make sure to only release one plugin at a time.
- Pick the latest stable commit from main.
- Agree on a version number with the team.
- Make sure the documentation is not out of date.
- Create a new release branch named after the new version, e.g.
release/<plugin_name>/<version_number>
. - Ensure that
RELEASE.md
file is up to date- Make sure all the changes since the last release of the plugin have been added to the
<plugin-name>/RELEASE.md
- Rename the "Upcoming Release" headline to "Release <version_number>". (Note: This is important for the release notes to be automatically generated)
- Make sure all the changes since the last release of the plugin have been added to the
- Rename the old version to the new version everywhere it is mentioned.
- Create a new Pull Request from the release branch to
main
. - Once approved by two reviewers, merge the pull request.
- Check to see if the GitHub Actions release workflow was executed properly.
- There should be a new GitHub release published for the plugin automatically.
- The package should have been successfully published to PyPI. You can verify this by running the following command:
pip install kedro-<plugin>==<new-version>
- Let the team know that the release is done and reach out to the Kedro devrel team to announce it on the Kedro Slack!