Skip to content

Commit

Permalink
Merge branch 'release-0.49.0' into auto-update/renku-core-2.9.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Panaetius authored Feb 21, 2024
2 parents ad977b3 + 924369b commit c305b5f
Show file tree
Hide file tree
Showing 11 changed files with 125 additions and 43 deletions.
13 changes: 0 additions & 13 deletions .github/workflows/publish-helm-chart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,3 @@ jobs:
if: always()
outputs:
chart-version: ${{ steps.vars.outputs.tag }}
rollout-renku-deployments:
runs-on: ubuntu-20.04
needs:
- "publish-chart"
steps:
- uses: actions/[email protected]
with:
fetch-depth: 0
- name: Rollout renku version
uses: SwissDataScienceCenter/renku-actions/[email protected]
env:
CHART_VERSION: ${{ needs.publish-chart.outputs.chart-version }}
GITHUB_TOKEN: ${{ secrets.RENKUBOT_GITHUB_TOKEN }}
28 changes: 28 additions & 0 deletions .github/workflows/release-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check release branch
on:
workflow_dispatch:
pull_request:
types: [opened,closed,synchronize,edited,review_requested,reopened]
branches:
- master
pull_request_review:
types: [submitted]
jobs:
check-open-prs:
if: startsWith(github.event.pull_request.head.ref, 'release-')
runs-on: ubuntu-latest
steps:
- name: Check unmerged PRs
uses: actions/github-script@v7
with:
script: |
const prs = await github.rest.pulls.list({
owner: context.repo.owner,
repo: context.repo.repo,
base: context.payload.pull_request.head.ref,
state: 'open'
})
const prs_filtered = prs.data.filter((p)=>!p.draft)
if ( prs_filtered.length > 0 ) {
core.setFailed('There are umerged open PRs targetting this branch:\n'+prs_filtered.map((p)=>p.title + ' ( ' + p.html_url + ' )').join('\n'))
}
49 changes: 47 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _changelog:


0.49.0
------

Expand All @@ -14,12 +13,58 @@ User-Facing Changes
- **Core Service**: Fix issue with having to run project migration twice to migrate the Dockerfile/project template.
(`#3690 <https://github.com/SwissDataScienceCenter/renku-python/issues/3690>`__)


Individual Components
~~~~~~~~~~~~~~~~~~~~~

- `renku-python 2.9.2 <https://github.com/SwissDataScienceCenter/renku-python/releases/tag/2.9.2>`_

0.48.1
------

Renku ``0.48.1`` only changes how the Terms of Use and Privacy Policy sections
can be customized by administrators.

0.48.0
------

Renku ``0.48.0`` introduces the ability to add a Terms of Use and Privacy Policy to
RenkuLab, as well as an assortment of small improvements and bug-fixes.

**🌟 New Features**

- 📜 **UI**: Show terms of use and privacy policy in the help section
(`#2954 <https://github.com/SwissDataScienceCenter/renku-ui/pull/2954>`_).

**✨ Improvements**

- 🖌 **UI**: Improve appearance of templates on new project page
(`#2999 <https://github.com/SwissDataScienceCenter/renku-ui/pull/2999>`_).
- 🛑 **UI**: Unify appearance of project settings alerts
(`#3001 <https://github.com/SwissDataScienceCenter/renku-ui/pull/3001>`_).

**🐞 Bug Fixes**

- **UI**: Restore logged in/out notifications
(`#3014 <https://github.com/SwissDataScienceCenter/renku-ui/pull/3014>`_).
- **UI**: Hide button to add storage on deployments not supporting external storages
(`#3001 <https://github.com/SwissDataScienceCenter/renku-ui/pull/3001>`_).
- **UI**: Fix landing page parallax background (`#3010 <https://github.com/SwissDataScienceCenter/renku-ui/pull/3010>`_).
- **UI**: Fix search bar styles (`#3019 <https://github.com/SwissDataScienceCenter/renku-ui/pull/3019>`_).
- **UI**: Handle ``jsonrpc`` improper redirects (`#3017 <https://github.com/SwissDataScienceCenter/renku-ui/pull/3017>`_, `#2966 <https://github.com/SwissDataScienceCenter/renku-ui/issues/2966>`_).

Internal Changes
~~~~~~~~~~~~~~~~

**Improvements**

- **UI**: Add initial alpha implementation of Renku 1.0 projects
(`#2875 <https://github.com/SwissDataScienceCenter/renku-ui/pull/2875>`_).

Individual components
~~~~~~~~~~~~~~~~~~~~~~

- `renku-ui 3.20.1 <https://github.com/SwissDataScienceCenter/renku-ui/releases/tag/3.20.1>`_
- `renku-ui 3.20.0 <https://github.com/SwissDataScienceCenter/renku-ui/releases/tag/3.20.0>`_

0.47.1
------
Expand Down
3 changes: 2 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ This procedure should be followed for *any* release:

* Create a release branch (e.g. `0.46.x`), if one does not already exist, with the [release action](https://github.com/SwissDataScienceCenter/renku/actions/workflows/create-release-branch.yml).
* Create a `CHANGELOG` entry for the release and open a PR; create a deployment, this is the reference for the release.
* Note that any PR that should go into the release needs to target the release branch _not_ `master`.
* Note that any PR that should go into the release needs to target the release branch _not_ `master`.
* All release branches should be protected.
* Use the "Rebase and Merge" button to merge release branches into `master`; do not squash commits.

Acceptance tests have to pass on all release branches before merging.

Expand Down
2 changes: 1 addition & 1 deletion acceptance-tests/build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ libraryDependencies += "io.circe" %% "circe-optics"
libraryDependencies += "org.http4s" %% "http4s-blaze-client" % "0.23.16" % Test
libraryDependencies += "org.http4s" %% "http4s-circe" % "0.23.25" % Test
libraryDependencies += "org.scalacheck" %% "scalacheck" % "1.17.0" % Test
libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.17" % Test
libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.18" % Test
libraryDependencies += "org.scalatestplus" %% "selenium-4-1" % "3.2.12.1" % Test
libraryDependencies += "org.seleniumhq.selenium" % "selenium-http-jdk-client" % "4.13.0" % Test
libraryDependencies += "org.seleniumhq.selenium" % "selenium-java" % "4.18.1" % Test
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@

# General information about the project.
project = "Renku"
copyright = "2017-2023, Swiss Data Science Center"
copyright = "2017-2024, Swiss Data Science Center"
author = ( "The Renku team and other contributors (see individual repositories)" )
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
27 changes: 14 additions & 13 deletions docs/how-to-guides/admin/privacycookie.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,20 @@ Privacy page and Terms of Use
The UI can be configured to show a `Privacy Policy` and `Terms of Use`. These are
displayed under the `Help` section of the UI.

For each of these, the content is read from a ``ConfigMap``. You need to configure
the values in ``ui.client.privacy.page`` to enable the feature and set the reference
ConfigMap name and key. If ``ui.client.privacy.page.enabled`` is ``true``, then the privacy
policy and terms of use will be shown in the UI, with content taken from the ConfigMap
specified by ``ui.client.privacy.page.configMapName`` at the key
``ui.client.privacy.page.configMapPolicyKey`` for the privacy policy and
``ui.client.privacy.page.configMapTermsKey`` for the terms of use.

.. note::

If you don't set the ConfigMap name and key,
`a sample <https://github.com/SwissDataScienceCenter/renku/blob/master/helm-chart/renku/templates/ui/ui-client-configmap.yaml>`_
will be used instead. You can start from it as a template to create your customized ConfigMap.
For each of these, the content is read from the ``privacy-and-terms`` ConfigMap.
You need to configure the values in ``ui.client.privacy.page`` to enable the feature.
If ``ui.client.privacy.page.enabled`` is ``true``, then the privacy
policy and terms of use will be shown in the UI.

Mind that you need to customize the content by either changing the ``privacy_statement``
and the ``terms`` keys in the ``privacy-and-terms`` ConfigMap, or assign a valid Markdown
text to ``ui.client.privacy.page.privacyPolicyContent`` and
``ui.client.privacy.page.termsContent``.

If you don't customize the text,
`a sample <https://github.com/SwissDataScienceCenter/renku/blob/master/helm-chart/renku/templates/ui/ui-client-configmap.yaml>`_
will be used instead. You can start from it as a template to create your own
content.

The `Markdown syntax <https://en.wikipedia.org/wiki/Markdown>`_ is fully supported for the
privacy page content.
Expand Down
8 changes: 5 additions & 3 deletions helm-chart/renku/templates/ui/ui-client-configmap.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ template "renku.fullname" . }}-privacy-sample
name: {{ template "renku.fullname" . }}-privacy-and-terms
labels:
app: ui
chart: {{ template "renku.chart" . }}
release: {{ .Release.Name }}
heritage: {{ .Release.Service }}
data:
privacy_statement: |
sample_privacy_statement: |
# Privacy statement
The content of this page is only a template.
## Information
Expand All @@ -25,7 +25,7 @@ data:
## Apply the changes
If you edit the ConfigMap content and you don't upgrade the deployment from helm, keep in mind that the
ui pod needs to be manually re-deployed in order to apply the changes to the privacy page.
terms: |
sample_terms: |
# Terms of Use
The content of this page is only a template.
## Information
Expand All @@ -41,3 +41,5 @@ data:
## Apply the changes
If you edit the ConfigMap content and you don't upgrade the deployment from helm, keep in mind that the
ui pod needs to be manually re-deployed in order to apply the changes to the terms page.
privacy_statement: {{ .Values.ui.client.privacy.page.privacyPolicyContent | default ("") | quote }}
terms: {{ .Values.ui.client.privacy.page.termsContent | default ("") | quote }}
14 changes: 11 additions & 3 deletions helm-chart/renku/templates/ui/ui-client-deployment-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,19 @@ spec:
volumes:
- name: privacy
configMap:
name: {{ .Values.ui.client.privacy.page.configMapName | default (printf "%s-privacy-sample" (include "renku.fullname" .)) | quote }}
name: {{ printf "%s-privacy-and-terms" (include "renku.fullname" .) | quote }}
items:
- key: {{ .Values.ui.client.privacy.page.configMapPolicyKey | default (printf "privacy_statement") | quote }}
{{- if .Values.ui.client.privacy.page.privacyPolicyContent }}
- key: "privacy_statement"
{{- else }}
- key: "sample_privacy_statement"
{{- end }}
path: statement.md
- key: {{ .Values.ui.client.privacy.page.configMapTermsKey | default (printf "terms") | quote }}
{{- if .Values.ui.client.privacy.page.termsContent }}
- key: "terms"
{{- else }}
- key: "sample_terms"
{{- end }}
path: terms.md

{{- end }}
Expand Down
11 changes: 5 additions & 6 deletions helm-chart/renku/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -692,15 +692,14 @@ ui:
dsn: ""
environment: ""
sampleRate: 0 # number between 0 and 1. (e.g., to send 20% of transactions, set 0.2.)
# If you want to enable the privacy page, please create also a configMap and set its name in the
# privacy.page.configMapName value. As a reference, you can use the sample configMap generated when
# enabling the feature.
privacy:
# If you want to enable the Privacy Policy and Terms of Service pages, you shoud add your custom content
# in privacyPolicyContent and termsContent. Markdown is supported.
# As a reference, you can use the "ui-client-configmap" configMap content in the "sample" sections.
page:
enabled: false
#configMapName: privacy-page
#configMapPolicyKey: privacy_statement
#configMapTermsKey: terms
#privacyPolicyContent: ""
#termsContent: ""
banner:
enabled: false
content: |
Expand Down
11 changes: 11 additions & 0 deletions helm-chart/values.yaml.changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ For changes that require manual steps other than changing values, please check o
Please follow this convention when adding a new row
* `<type: NEW|EDIT|DELETE> - *<resource name>*: <details>`

## Upgrading to Renku 0.48.1

The handling of privacy policy and terms of service content has been fine tuned.

* DELETE `ui.client.privacy.page.configMapName` has been removed.
* DELETE `ui.client.privacy.page.configMapPolicyKey` has been removed.
* DELETE `ui.client.privacy.page.configMapTermsKey` has been removed.
* NEW ``ui.client.privacy.page.privacyPolicyContent`` to customize the content of the Privacy Policy page (supports Markdown).
* NEW ``ui.client.privacy.page.termsContent`` to customize the content of the Terms of Use page (supports Markdown).


## Upgrading to Renku 0.48.0

The handling of privacy policy and terms of service content has been slightly changed to make
Expand Down

0 comments on commit c305b5f

Please sign in to comment.