df-research/dataframe/RELEASE_CHECK_LIST.md

Release activities check-list for releases:

1. Run code inspections (fix typos, Kotlin issues, fix code formatting, linter). RC
2. Write missed KDocs for new APIs. RC
3. Update documentation on Kotlin site RC
   • The overview page
   • The Data Analysis subchapter, for example, the page
4. Update tutorials according to the latest code changes.
5. Update README.MD according last code changes:
   • update an artifact version.
   • update a Kotlin version.
   • update the section about library versions.
6. Check the project version in the file gradle.properties (i.e. it's 0.10.0 when trying to release version 0.10.0).
   • For major releases: update a project version in the file v.list
   • For major releases: update a project version in the file main.yml
   • For major releases: update a project version in the file project.ihp
7. Update libs.versions.toml file if required, run ./gradlew dependencyUpdates to check for updates. RC
8. Create and checkout the release branch. RC
9. Make last commit with release tag (v0.1.1 for example) to the release branch. RC
10. Run tests and build artifacts on TC for the commit with the release tag. RC
11. Deploy artifacts on Maven Central via the Publish task (directly and without pre-run dependencies) on TC based on the commit with the release tag. RC
12. Check artifacts' availability on MavenCentral. RC
13. Check Gradle Plugin portal availability (usually it takes 12 hours). RC
14. Update a bootstrap dependency version in the libs.versions.toml file (only after the plugin's publication). RC
15. Do final testing: RC
    • Check on Datalore with a test project (TODO: add link).
    • Check for Android with a test project (TODO: add link).
    • Check for ServerSide with a test project (TODO: add link).
16. Publish Documentation from GitHub Action
17. Prepare and publish the Release Notes.
18. Create a Release from the release tag on GitHub.
19. Update a KDF version in the Kotlin Jupyter Descriptor. Now the Renovate bot does this.
20. Update the DataFrame version in the gradle.properties file for the next release cycle (i.e. 0.10.0 -> 0.11.0)
21. Update deprecated functions in deprecationMessages.kt such that
    • Level.WARNING messages are changed to Level.ERROR
    • Level.ERROR messages and their functions are removed.
    • Update regions in the file accordingly.
22. Update Notebook examples, both in the project and on Datalore.
    • Dev notebooks may contain updated code for release Notebook examples.

(Activities that need to be done for Release Candidate releases are marked as such)