Merge pull request #392 from plone/maintenance-pnpm

Package maintenance

Author: petschki

dependabot.yml .github/dependabot.ymldependabot.yml renamed to .github/dependabot.yml

@@ -25,24 +25,21 @@ on:
 
 jobs:
   qa:
-    uses: plone/meta/.github/workflows/qa.yml@main
-  test:
-    uses: plone/meta/.github/workflows/test.yml@main
+    uses: plone/meta/.github/workflows/[email protected]
   coverage:
-    uses: plone/meta/.github/workflows/coverage.yml@main
+    uses: plone/meta/.github/workflows/coverage.yml@2.x
   dependencies:
-    uses: plone/meta/.github/workflows/dependencies.yml@main
+    uses: plone/meta/.github/workflows/dependencies.yml@2.x
   release_ready:
-    uses: plone/meta/.github/workflows/release_ready.yml@main
+    uses: plone/meta/.github/workflows/release_ready.yml@2.x
   circular:
-    uses: plone/meta/.github/workflows/circular.yml@main
+    uses: plone/meta/.github/workflows/circular.yml@2.x
 
 ##
 # To modify the list of default jobs being created add in .meta.toml:
 # [github]
 # jobs = [
 #    "qa",
-#    "test",
 #    "coverage",
 #    "dependencies",
 #    "release_ready",
@@ -57,13 +54,6 @@ jobs:
 # os_dependencies = "git libxml2 libxslt"
 ##
 
-##
-# To test against a specific matrix of python versions
-# when running tests jobs, add in .meta.toml:
-# [github]
-# py_versions = "['3.12', '3.11']"
-##
-
 
 ##
 # Specify additional jobs in .meta.toml:

.github/workflows/meta.yml

@@ -0,0 +1,52 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/src/plone/meta/default
+# See the inline comments on how to expand/tweak this configuration file
+name: Tests
+
+on:
+  push:
+
+jobs:
+  build:
+    permissions:
+      contents: read
+      pull-requests: write
+    strategy:
+      # We want to see all failures:
+      fail-fast: false
+      matrix:
+        os:
+        - ["ubuntu", "ubuntu-latest"]
+        config:
+        # [Python version, visual name, tox env]
+        - ["3.13", "6.2 on py3.13", "py313-plone62"]
+        - ["3.10", "6.2 on py3.10", "py310-plone62"]
+        - ["3.13", "6.1 on py3.13", "py313-plone61"]
+        - ["3.10", "6.1 on py3.10", "py310-plone61"]
+
+    runs-on: ${{ matrix.os[1] }}
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    name: ${{ matrix.config[1] }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.config[0] }}
+        allow-prereleases: true
+    - name: Pip cache
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ matrix.config[0] }}-${{ hashFiles('setup.*', 'tox.ini') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-${{ matrix.config[0] }}-
+          ${{ runner.os }}-pip-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+    - name: Test
+      run: tox -e ${{ matrix.config[2] }}

.github/workflows/test-matrix.yml

@@ -3,7 +3,10 @@
 # See the inline comments on how to expand/tweak this configuration file
 [meta]
 template = "default"
-commit-id = "770f41af"
+commit-id = "2.0.1.dev0"
 
 [pyproject]
-codespell_skip = "*.css.map,package-lock.json"
+codespell_skip = "*.css.map,pnpm-lock.yaml"
+
+[tox]
+test_matrix = {"6.2" = ["3.13", "3.10"], "6.1" = ["3.13", "3.10"]}

.meta.toml

@@ -1 +1 @@
-Please see http://docs.plone.org/develop/coredev/docs/guidelines.html
+Please see https://6.docs.plone.org/contributing/core/

CONTRIBUTING.rst

@@ -0,0 +1,85 @@
+## Install package manager
+
+### pnpm
+
+Using corepack:
+
+```shell
+corepack prepare pnpm@latest --activate
+```
+
+or using `npm`:
+
+```shell
+npm install -g pnpm@latest
+```
+
+Verify the latest version.
+
+```shell
+pnpm --version
+```
+
+### Install dependencies
+
+In order to develop plonetheme.barceloneta you need to execute on the root of the package::
+
+```shell
+pnpm install
+```
+
+You can also updated dependencies with
+
+```shell
+pnpm update
+```
+
+After executing this you can run the following command to watch for any scss changes
+in the path `plonetheme.barceloneta/scss`::
+
+```shell
+pnpm watch
+```
+
+This will make sure that the many .scss files are compiled to .css on the fly
+and then copied over to the theme.
+
+If you simply want to compile all resources before a release run::
+
+```shell
+pnpm build
+```
+
+
+## Release Instructions
+
+```{note}
+You need the correct access rights to publish to npm or pypi.
+```
+
+- First create a pypi release using zest.releaser. This tool also creates the correct tag based on the setup.py version.
+- After the pypi release edit the release version in package.json.
+  Or better yet, run something like `pnpm version 3.2.0-alpha.5`
+- Run: `pnpm publish`
+
+
+### Pre-Releases
+
+Based on https://survivejs.com/maintenance/packaging/publishing/#publishing-a-pre-release-version
+
+- Change version in package.json to corresponding version in setup.py
+- You can also use `pnpm version 3.0.0-beta1` - This will change the version in package.json and create a git tag.
+- `pnpm publish --tag beta` - Publish the package under beta tag.
+- Mark beta release as latest with `npm dist-tag add @plone/plonetheme-barceloneta-base@3.0.0-beta1 latest``
+
+To consume the test version, users have to use `pnpm install @plone/plonetheme-barceloneta-base@beta`.
+
+
+## Theme
+
+See `plonetheme.barceloneta/plonetheme/barceloneta/theme/rules.xml` for the relevant Diazo theme rules.
+
+
+## Fonts
+
+Read `plonetheme.barceloneta/plonetheme/barceloneta/theme/roboto/README.rst` if you need to update the shipped fonts.

HOWTO_DEVELOP.md

@@ -11,3 +11,4 @@ exclude yarn.lock
 exclude package.json
 exclude postcss.config.js
 exclude .stylelint*
+exclude pnpm-lock.yaml

HOWTO_DEVELOP.rst

@@ -1,6 +1,6 @@
 # Barceloneta
 
-Classic theme resources for Plone 6 - based on Bootstrap 5
+Classic-UI theme resources for Plone 6 - based on Bootstrap 5
 
 This package provides scss resources to build your own theme based on the Plone default theme for (backend rendered) Classic UI of Plone.
 
@@ -15,10 +15,15 @@ https://github.com/plone/plonetheme.barceloneta/blob/master/CHANGES.md
 ## Source Code and Contribution
 
 ### Contributors
-Please read the document [Contributing to Plone](https://6.docs.plone.org/contributing/index.html). Also consult the document [Contributing to `plone.api`](https://6.docs.plone.org/plone.api/contribute/index.html).
+
+Please read the document [Contributing to Plone](https://6.docs.plone.org/contributing/index.html).
+
+Also consult the development notes [Develop Barceloneta Theme](https://github.com/plone/plonetheme.barceloneta/blob/master/HOWTO_DEVELOP.md).
 
 ### Source-Code
+
 Plone code repository hosted at Github https://github.com/plone/plonetheme.barceloneta.
 
 ### Issues
+
 Please use the [Issue-Tracker](https://github.com/plone/plonetheme.barceloneta/issues)