Upstream merge

.github/workflows/test.yml

@@ -2,12 +2,12 @@ name: Tests
 on: [push, pull_request]
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4.2.2
+      - uses: actions/setup-python@v5.6.0
         with:
-          python-version: '3.8'
+          python-version: '3.12'
       - name: Install requirements
         run: pip install flake8 pycodestyle
       - name: Check syntax
@@ -17,16 +17,23 @@ jobs:
     needs: lint
     strategy:
       matrix:
-        ckan-version: ["2.10", 2.9, 2.9-py2, 2.8, 2.7]
+        include:
+          - ckan-version: "2.11"
+            ckan-image: "ckan/ckan-dev:2.11-py3.10"
+          - ckan-version: "2.10"
+            ckan-image: "ckan/ckan-dev:2.10-py3.10"
+          - ckan-version: "2.9"
+            ckan-image: "ckan/ckan-dev:2.9-py3.9"
       fail-fast: false
 
     name: CKAN ${{ matrix.ckan-version }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     container:
-      image: openknowledge/ckan-dev:${{ matrix.ckan-version }}
+      image: ${{ matrix.ckan-image }}
+      options: --user root
     services:
       solr:
-        image: ckan/ckan-solr:${{ matrix.ckan-version }}
+        image: ckan/ckan-solr:${{ matrix.ckan-version }}-solr9
       postgres:
         image: ckan/ckan-postgres-dev:${{ matrix.ckan-version }}
         env:
@@ -44,33 +51,29 @@ jobs:
       CKAN_REDIS_URL: redis://redis:6379/1
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4.2.2
     - name: Install requirements
       run: |
         pip install -r requirements.txt
         pip install -r dev-requirements.txt
         pip install -e .
         # Replace default path to CKAN core config file with the one on the container
         sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini
+
     - name: Setup extension (CKAN >= 2.9)
-      if: ${{ matrix.ckan-version != '2.7' && matrix.ckan-version != '2.8' }}
       run: |
         ckan -c test.ini db init
-    - name: Setup extension (CKAN < 2.9)
-      if: ${{ matrix.ckan-version == '2.7' || matrix.ckan-version == '2.8' }}
-      run: |
-        paster --plugin=ckan db init -c test.ini
+        ckan -c test.ini db upgrade -p showcase
+
     - name: Run tests
-      run: pytest --ckan-ini=test.ini --cov=ckanext.showcase --cov-report=xml --cov-append --disable-warnings ckanext/showcase/tests
+      run: pytest --ckan-ini=test.ini --cov=ckanext.showcase --cov-report=term-missing --cov-append --disable-warnings ckanext/showcase/tests
+
+    - name: Install unzip for SonarQube and cov
+      run: apt-get -y install unzip curl
 
-    - name: Upload coverage report to codecov
-      uses: codecov/codecov-action@v1
-      with:
-        file: ./coverage.xml
-
     - name: SonarQube Scan
       uses: sonarsource/sonarqube-scan-action@master
-      with: 
+      with:
         args: >
           -Dsonar.projectKey=ckanext-showcase
           -Dsonar.sources=ckanext/showcase

.gitignore

@@ -13,7 +13,6 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
-build/
 develop-eggs/
 sdist/
 *.egg-info/

CHANGELOG.md

@@ -1,5 +1,32 @@
 # Ckanext-showcase CHANGELOG
 
+## v1.8.1 2025-01-29
+
+*  Fixes delete and update showcase buttons (#173)
+*  Update MANIFEST.in to include migration files and public assets (#174)
+
+## v1.8.0 2025-01-28
+
+* Add CKAN 2.11 support (#170) 
+
+## v1.7.0 2024-04-17
+
+* Fix navigation menu headers (#169)
+* Add English Australia (en_AU) translation files (#168)
+
+## v1.6.1 2023-06-15
+* Fixed BS5 class and add CSRF support to all forms (#167)
+* String prefix cleanup (#165)
+
+## v1.6.0 2023-02-14
+
+* Dropped support for CKAN 2.7 and 2.8
+* Dropped support for Python 2
+* Add support for CSRF token
+* Sanitize blueprint names. All views should be called using `showcase_blueprint.<endpoint>`
+* Rename get_showcase_wysiwyg_editor to avoid name clashes with other extensions (like `ckanext-pages`)
+* Update CKEditor to it's latest version: 36.0.1
+
 ## v1.5.1 2022-08-10
 
 * Dependency update

MANIFEST.in

@@ -2,3 +2,5 @@ include README.rst
 recursive-include ckanext/showcase/templates *
 recursive-include ckanext/showcase/i18n *
 recursive-include ckanext/showcase/fanstatic *
+recursive-include ckanext/showcase/migration *.ini *.py *.mako
+recursive-include ckanext/showcase/public *.*

README.rst

@@ -30,7 +30,9 @@ ckanext-showcase is intended to be a more powerful replacement for the
 Requirements
 ------------
 
-Tested on CKAN 2.7 to 2.10..
+Tested on CKAN 2.9 to 2.11.
+
+Note: Use `1.5.2` for older CKAN versions (2.7 and 2.8).
 
 ------------
 Installation
@@ -54,10 +56,12 @@ To install ckanext-showcase:
    config file (by default the config file is located at
    ``/etc/ckan/default/production.ini``).
 
-4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
+4. Create the database tables::
+
+    ckan db upgrade -p showcase
 
-     sudo service apache2 reload
 
+5. Restart CKAN. 
 
 ------------------------
 Development Installation
@@ -68,7 +72,7 @@ do::
 
     git clone https://github.com/ckan/ckanext-showcase.git
     cd ckanext-showcase
-    python setup.py develop
+    pip install -e .
     pip install -r dev-requirements.txt
 
 
@@ -79,11 +83,14 @@ repository contains all the files needed to edit and customize it if needed::
     npm install
     npx webpack --config webpack.config.js
 
-The webpack will use as entrypoint a file located in `ckanext/showcase/fanstatic/src/ckeditor.js`,
-create a build and save it to `ckanext/showcase/fanstatic/dist/ckeditor.js`
+Build anatomy
+ * assets/build/ckeditor.js - The ready-to-use editor bundle, containing the editor and all plugins.
+ * assets/js/showcase-editor - The CKAN module that will load and config the bundle when using it as data-module attribute.
+ * assets/src/ckeditor.js - The source entry point of the build. Based on it the build/ckeditor.js file is created by webpack. It defines the editor creator, the list of plugins and the default configuration of a build.
+ * webpack.config.js - The webpack configuration used to build the editor.
 
 More info on how to build CKEditor from source:
-https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/advanced-setup.html#scenario-2-building-from-source
+https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start-other.html#building-the-editor-from-source
 
 
 ---
@@ -168,20 +175,15 @@ HTML you can use the ```showcase markdown_to_html``` command.
 
 From the ``ckanext-showcase`` directory::
 
-    paster showcase markdown-to-html -c {path to production.ini}
+    ckan -c {path to production.ini} showcase markdown-to-html
 
 -----------------
 Running the Tests
 -----------------
 
 To run the tests, do::
 
-    nosetests --ckan --nologcapture --with-pylons=test.ini
-
-To run the tests and produce a coverage report, first make sure you have
-coverage installed in your virtualenv (``pip install coverage``) then run::
-
-    nosetests --ckan --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.showcase --cover-inclusive --cover-erase --cover-tests
+    pytest --ckan-ini=test.ini ckanext/showcase/tests
 
 
 ------------------------------------