Merge pull request #2942 from SwissDataScienceCenter/release/v1.4.0

chore: release v1.4.0

.pre-commit-config.yaml

@@ -1,36 +1,54 @@
+default_language_version:
+    python: python3.8
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
-    hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-    -   id: black
-        additional_dependencies: ['click==8.0.4']
--   repo: https://github.com/pycqa/isort
-    rev: 5.10.1
-    hooks:
-    -   id: isort
-        name: isort (python)
--   repo: https://github.com/pycqa/flake8
-    rev: '3.9.2'
-    hooks:
-    -   id: flake8
-        exclude: ^docs/
-        args:
-        - "--max-line-length=120"
-        - "--show-source"
-        - "--ignore=E121,E126,E203,E226,E231,W503,W504"
--   repo: https://github.com/pycqa/pydocstyle
-    rev: 4.0.1
-    hooks:
-    -   id: pydocstyle
-        args:
-        - --ignore=D105,D107,D202,D203,D212,D213,D401,D406,D407,D410,D411,D413
--   repo: https://github.com/koalaman/shellcheck-precommit
-    rev: v0.8.0
-    hooks:
-    -   id: shellcheck
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v2.3.0
+      hooks:
+          - id: check-yaml
+          - id: end-of-file-fixer
+          - id: trailing-whitespace
+    - repo: https://github.com/psf/black
+      rev: 22.3.0
+      hooks:
+          - id: black
+            additional_dependencies: ["click==8.0.4"]
+    - repo: https://github.com/pycqa/isort
+      rev: 5.10.1
+      hooks:
+          - id: isort
+            name: isort (python)
+    - repo: https://github.com/pycqa/flake8
+      rev: "3.9.2"
+      hooks:
+          - id: flake8
+            exclude: ^docs/
+            args:
+                - "--max-line-length=120"
+                - "--show-source"
+                - "--ignore=E121,E126,E203,E226,E231,W503,W504"
+    - repo: https://github.com/pycqa/pydocstyle
+      rev: 4.0.1
+      hooks:
+          - id: pydocstyle
+            args:
+                - --ignore=D105,D107,D202,D203,D212,D213,D401,D406,D407,D410,D411,D413
+    - repo: https://github.com/koalaman/shellcheck-precommit
+      rev: v0.8.0
+      hooks:
+          - id: shellcheck
+    - repo: https://github.com/pre-commit/mirrors-mypy
+      rev: "v0.961"
+      hooks:
+          - id: mypy
+            language_version: '3.8'
+            args:
+            - --no-strict-optional
+            - --ignore-missing-imports
+            additional_dependencies:
+            - types-python-dateutil>=2.8.10
+            - types-PyYAML<6.1.0,>=5.4
+            - types-redis>=3.5.3,<4.1.0
+            - types-requests<2.27.2,>=2.23.0
+            - types-tabulate<0.8.10,>=0.7.7
+            - attrs<21.5.0,>=21.4.0
+            - filelock>=3.3.0,<3.6.1

CHANGES.rst

@@ -18,6 +18,47 @@
 Changes
 =======
 
+`1.4.0 <https://github.com/SwissDataScienceCenter/renku-python/compare/v1.3.1...v1.4.0>`__ (2022-06-10)
+-------------------------------------------------------------------------------------------------------
+
+Bug Fixes
+~~~~~~~~~
+
+-  **core:** automatically cleanup dangling git processes
+   (`#2928 <https://github.com/SwissDataScienceCenter/renku-python/issues/2928>`__)
+   (`56b06b5 <https://github.com/SwissDataScienceCenter/renku-python/commit/56b06b5af8486c7f5675fe943259bd9975a7dd5d>`__)
+
+Features
+~~~~~~~~
+
+-  **dataset:** import dataset at specific tags
+   (`#2926 <https://github.com/SwissDataScienceCenter/renku-python/issues/2926>`__)
+   (`c948a77 <https://github.com/SwissDataScienceCenter/renku-python/commit/c948a7763ed9c2b683dd9a622099485408690cd1>`__)
+-  **cli:** show dataset metadata for tag
+   (`#2919 <https://github.com/SwissDataScienceCenter/renku-python/issues/2919>`__)
+   (`713b4a4 <https://github.com/SwissDataScienceCenter/renku-python/commit/713b4a4db1ad514d88bdb211c990b4ab9c389322>`__)
+-  **api:** add activity support to Renku api
+   (`#2911 <https://github.com/SwissDataScienceCenter/renku-python/issues/2911>`__)
+   (`37d50ae <https://github.com/SwissDataScienceCenter/renku-python/commit/37d50ae667a504f046317245dc1047b7023d2d81>`__)
+-  **cli:** add support for setting custom metadata on Plans
+   (`#2929 <https://github.com/SwissDataScienceCenter/renku-python/issues/2929>`__)
+   (`c99659f <https://github.com/SwissDataScienceCenter/renku-python/commit/c99659f93dbdb3898bf9d58634c4d0fcdcdcf831>`__)
+-  **cli:** add pager support to renku log
+   (`#2932 <https://github.com/SwissDataScienceCenter/renku-python/issues/2932>`__)
+   (`31f9514 <https://github.com/SwissDataScienceCenter/renku-python/commit/31f9514c19f97a1260b763cf752326d685fdf2b0>`__)
+-  **cli:** add renku template validate command
+   (`#2936 <https://github.com/SwissDataScienceCenter/renku-python/issues/2936>`__)
+   (`bc56b8b <https://github.com/SwissDataScienceCenter/renku-python/commit/bc56b8be751f6ee376d2d27fd72473f8a31d4676>`__)
+-  **cli:** improve renku run error messages
+   (`#2915 <https://github.com/SwissDataScienceCenter/renku-python/issues/2915>`__)
+   (`5cc006c <https://github.com/SwissDataScienceCenter/renku-python/commit/5cc006caa475c57da7c3b568c8c24dd0601d0e28>`__)
+-  **core:** add remote Renku instance session provider
+   (`#2880 <https://github.com/SwissDataScienceCenter/renku-python/issues/2880>`__)
+   (`f554f19 <https://github.com/SwissDataScienceCenter/renku-python/commit/f554f192ef83fb7f2c7f44ef3da5c6b5487264ca>`__)
+-  **core:** use oauth 2.0 device auth grant for renku login
+   (`#2722 <https://github.com/SwissDataScienceCenter/renku-python/issues/2722>`__)
+   (`eae254e <https://github.com/SwissDataScienceCenter/renku-python/commit/eae254e90d1bf52da9efe68096139df14d84dfd1>`__)
+
 `1.3.1 <https://github.com/SwissDataScienceCenter/renku-python/compare/v1.3.0...v1.3.1>`__ (2022-05-23)
 -------------------------------------------------------------------------------------------------------
 

DEVELOPING.rst

@@ -231,8 +231,38 @@ Branching Model
 We follow the git-flow_ model of branches for development, with ``master`` being
 the release branch and ``develop`` being the development branch.
 
-Release branches should be created off of master, have develop merged into them
-and then should be merged (not squash merged) back into master. A Github Action
-will then take care of merging master back into develop.
-
 .. _git-flow: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+
+Making a Release
+----------------
+This section uses `v1.2.3` as an example, replace it with the actual version
+number.
+
+- Create a new release branch off of **master**. **Do not** call this branch
+  e.g. `v1.2.3`, it cannot have the same name as the release version.
+- Merge changes from `develop` into the release branch (plain merge, **don't
+  squash**).
+- Run `conventional-changelog -r 1 -p angular | pandoc --from markdown --to rst`
+  to get the changelog and update `CHANGES:rst` with it. Make sure to fill in
+  the version number in the header and to replace the `=` underline with `-`.
+- Proof-read the changelog and adjust messages so they make sense to third
+  parties reading the changelog
+- Update the version in `helm-chart/renku-core/Chart.yaml` and `helm-chart/renku-core/values.yaml`
+  (for `versions.latest.image.tag`).
+- Commit the changes to the release branch, with a message like "chore: release
+  v1.2.3"
+- Push the release branch and create a PR **against master**. Wait for it to be
+  approved. **Do not squash merge this PR!** Use a regular merge.
+- Create a new `github release <https://github.com/SwissDataScienceCenter/renku-python/releases/new>`_.
+  Set to create a new tag like `v1.2.3` against master, title should be
+  `v1.2.3` as well. The description should be the output of
+  `conventional-changelog -r 1 -p angular` with the same adjustments done above
+  for the `CHANGES.rst` file.
+- Once the release PR has been merged, publish the github release. This creates
+  the tag on master that kicks off the publishing CI.
+- Keep an eye on CI, make sure that the `publish-pypi`, `build-images`,
+  `publish-chart` and `update-develop-branch` finish successfully.
+  * If any of them don't finish successfully, ask for help.
+- Go to the `Renku` repository and approve/merge the automatically created PR
+  there.
+- Announce that we have a new version through appropriate channels.

docs/reference/api.rst

@@ -39,7 +39,14 @@ Renku Python API
 
 .. automodule:: renku.ui.api.models.plan
 
-.. _api-run:
+.. _api-activity:
+
+``Activity``
+------------
+
+.. automodule:: renku.ui.api.models.activity
+
+.. _api-parameter:
 
 ``Inputs, Outputs, and Parameters``
 -----------------------------------

docs/reference/commands.rst

@@ -196,6 +196,13 @@ Renku Command Line
 
 .. automodule:: renku.ui.cli.githooks
 
+``renku session``
+-----------------
+
+.. automodule:: renku.ui.cli.session
+
+.. _cli-session:
+
 Error Tracking
 --------------
 

docs/reference/models/refs.rst

@@ -18,5 +18,5 @@
 File References
 ===============
 
-.. automodule:: renku.domain_model.refs
+.. automodule:: renku.core.migration.models.refs
    :members:

docs/spelling_wordlist.txt

@@ -1,4 +1,5 @@
 acyclic
+adhoc
 admin
 Amalthea
 analytics
@@ -243,6 +244,7 @@ Unlink
 unlinking
 unmapped
 unmerged
+unpushed
 untracked
 untracked
 updatable

helm-chart/renku-core/Chart.yaml

@@ -3,4 +3,4 @@ appVersion: "1.0"
 description: A Helm chart for Kubernetes
 name: renku-core
 icon: https://avatars0.githubusercontent.com/u/53332360?s=400&u=a4311d22842343604ef61a8c8a1e5793209a67e9&v=4
-version: 1.3.1
+version: 1.4.0

helm-chart/renku-core/values.yaml

@@ -72,7 +72,7 @@ metrics:
   enabled: false
   image:
     repository: renku/rqmetrics
-    tag: latest
+    tag: 0.0.2
     pullPolicy: IfNotPresent
 
 resources: {}
@@ -109,7 +109,7 @@ versions:
     fullnameOverride: ""
     image:
       repository: renku/renku-core
-      tag: "v1.3.1"
+      tag: "v1.4.0"
       pullPolicy: IfNotPresent
   v8:
     name: v8