cleanup for v0.13.2 (#1275)

bihealth · Sep 21, 2023 · 7fb6eaa · 7fb6eaa
1 parent a57f28c
commit 7fb6eaa
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 9 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -13,8 +13,10 @@ Added
 
 - **General**
     - Release cleanup issue template (#1289)
+    - Use ``sodar-pr-btn-submit-once`` in object create forms (#1233)
 - **Projectroles**
     - ``queryset_project_field`` override in ``APIProjectContextMixin`` (#1273)
+    - ``sodar-pr-btn-submit-once`` class for forms (#1233)
 
 Changed
 -------

diff --git a/bgjobs/templates/bgjobs/_details_card.html b/bgjobs/templates/bgjobs/_details_card.html
@@ -18,7 +18,7 @@
       {% endfor %}
     {% else %}
         <tr>
-          <td class="bg-faded font-italic text-center" colspan="5">No background jobs</td>
+          <td class="bg-faded font-italic text-center" colspan="5">No background jobs.</td>
         </tr>
     {% endif %}
   </tbody>

diff --git a/docs/source/app_projectroles_settings.rst b/docs/source/app_projectroles_settings.rst
@@ -246,7 +246,7 @@ The following projectroles settings are **optional**:
     (list)
 ``PROJECTROLES_HIDE_APP_LINKS``
     **DEPRECATED**, use ``PROJECTROLES_HIDE_PROJECT_APPS`` instead. This will be
-    emoved in v0.14
+    removed in v1.0
 ``PROJECTROLES_DELEGATE_LIMIT``
     The number of delegate roles allowed per project. The amount is limited to 1
     per project if not set, unlimited if set to 0. Will be ignored for remote

diff --git a/docs/source/dev_project_app.rst b/docs/source/dev_project_app.rst
@@ -192,7 +192,9 @@ member variables and functions as instructed in comments and docstrings.
 The following variables and functions are **mandatory**:
 
 ``name``
-    App name. In most cases this should match the app package name.
+    App name. If only introducing a single plugin in your app, it is recommended
+    to have this match the app name. Note that the name variables of plugins are
+    expected to be unique, although not currently strictly enforced.
 ``title``
     Printable app title.
 ``urls``

diff --git a/docs/source/dev_resource.rst b/docs/source/dev_resource.rst
@@ -141,6 +141,15 @@ Markdown
 For fields supporting markdown, it is recommended to use the
 ``SODARPagedownWidget`` found in ``projectroles.models``.
 
+Submit Multi-Click Protection
+-----------------------------
+
+To avoid unwanted effects from a user clicking the submit button on a form
+multiple times, it is recommended to use the ``sodar-pr-btn-submit-once`` class
+on the submit button in your server-side form templates. Introducing this class
+will disable the button after the initial click while the form is submitted.
+This is especially recommended for forms responsible for creating objects.
+
 
 App Settings
 ============

diff --git a/docs/source/major_changes.rst b/docs/source/major_changes.rst
@@ -10,13 +10,14 @@ older SODAR Core version. For a complete list of changes in current and previous
 releases, see the :ref:`full changelog<changelog>`.
 
 
-v0.13.2 (WIP)
-*************
+v0.13.2 (2023-09-21)
+********************
 
 Release Highlights
 ==================
 
 - Add REST API project context queryset field override
+- Add sodar-pr-btn-submit-once class for forms with usage
 - Fix project list view rendering issues with finder role
 - General bug fixes and minor updates
 
@@ -208,6 +209,15 @@ Advanced search has been updated to use POST requests. This should not require
 any changes in the plugin search implementation. However, if you have set up
 view tests for advanced search in your apps, they may have to be updated.
 
+Base Template Content Element Changed
+-------------------------------------
+
+The behaviour of the ``sodar-app-content`` element in the projectroles base
+template has changed. The element can now be assigned the
+``sodar-app-content-project`` class if a project context is present. If you are
+referring to this element in custom Javascript, it is recommended to refer to
+the element with the ID ``#sodar-app-content`` instead of the class name.
+
 System Prerequisites
 --------------------
 
@@ -225,7 +235,7 @@ PROJECTROLES_HIDE_APP_LINKS Deprecated
 The ``PROJECTROLES_HIDE_APP_LINKS`` Django setting has been depreacted. Instead,
 you should use ``PROJECTROLES_HIDE_PROJECT_APPS`` which now handles the same
 functionality. Support for the ``PROJECTROLES_HIDE_APP_LINKS`` setting will be
-removed in v0.14.
+removed in v1.0.
 
 Deprecated App Settings API Methods Removed
 -------------------------------------------

diff --git a/filesfolders/templates/filesfolders/_details_card.html b/filesfolders/templates/filesfolders/_details_card.html
@@ -54,7 +54,7 @@
         {% endfor %}
       {% else %}
         <tr>
-          <td class="font-italic text-center" colspan="6">No files or links</td>
+          <td class="font-italic text-center" colspan="6">No files or links.</td>
         </tr>
       {% endif %}
     </tbody>

diff --git a/projectroles/templatetags/projectroles_tags.py b/projectroles/templatetags/projectroles_tags.py
@@ -89,7 +89,7 @@ def is_app_visible(plugin, project, user):
     app_hidden = False
     if plugin.name in getattr(settings, 'PROJECTROLES_HIDE_PROJECT_APPS', []):
         app_hidden = True
-    # TODO: Remove this in SODAR Core v0.14 (see issue #1143)
+    # TODO: Remove this in SODAR Core v1.0 (see issue #1143)
     elif plugin.name in getattr(settings, 'PROJECTROLES_HIDE_APP_LINKS', []):
         app_hidden = True
     if (

diff --git a/siteinfo/views.py b/siteinfo/views.py
@@ -20,6 +20,7 @@
 
 # Local constants
 CORE_SETTINGS = [
+    'ADMINS',
     'ALLOWED_HOSTS',
     'APPS_DIR',
     'AUTH_LDAP_SERVER_URI',
@@ -54,7 +55,7 @@
     'PROJECTROLES_ENABLE_PROFILING',
     'PROJECTROLES_ENABLE_SEARCH',
     'PROJECTROLES_HELP_HIGHLIGHT_DAYS',
-    'PROJECTROLES_HIDE_APP_LINKS',  # TODO: Remove in v0.14 (see issue #1143)
+    'PROJECTROLES_HIDE_APP_LINKS',  # TODO: Remove in v1.0 (see issue #1143)
     'PROJECTROLES_HIDE_PROJECT_APPS',
     'PROJECTROLES_INLINE_HEAD_INCLUDE',
     'PROJECTROLES_INVITE_EXPIRY_DAYS',