From 847ba10c26518a79c1c8aef2fefab43df4dc7833 Mon Sep 17 00:00:00 2001 From: tyong920 Date: Thu, 11 Jul 2024 11:53:13 +0800 Subject: [PATCH 1/3] Fix `include_metadata` typo to `inherit_metadata` and add documentation note (#17) - Corrected the typo from `include_metadata` to `inherit_metadata` in the documentation. - Added a note to clarify the usage of `pdm lock` with dependency groups. --- doc/src/plugins/backend.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/src/plugins/backend.rst b/doc/src/plugins/backend.rst index d9ec08b..2dc6d8e 100644 --- a/doc/src/plugins/backend.rst +++ b/doc/src/plugins/backend.rst @@ -10,8 +10,12 @@ To set it up, a few configuration steps are required. Lockfile configuration ====================== -Your lockfile must be configured with the ``include_metadata`` strategy (``pdm>=2.11``) and include locks for the -optional-dependencies groups you want to publish locked. +Your lockfile must be configured with the ``inherit_metadata`` strategy (``pdm>=2.11``) and include locks for the optional-dependencies groups you want to publish locked. + + .. note:: + When running ``pdm lock``, ensure you select the appropriate dependency groups. + + For instance, you can use ``pdm lock -G :all`` and then verify that the ``[metadata]`` section of the ``pdm.lock`` file includes the desired groups. For more details, refer to the ``Dependencies Selection:`` section in the ``pdm lock --help`` output. buildsystem configuration ========================= From 056b3aaab379df3846299cab523d9fe7f62e2e12 Mon Sep 17 00:00:00 2001 From: Frost Ming Date: Thu, 11 Jul 2024 11:55:23 +0800 Subject: [PATCH 2/3] chore: fix changelog generationworkflow Signed-off-by: Frost Ming --- .github/workflows/pythonpublish.yml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml index 7770820..eca62f5 100644 --- a/.github/workflows/pythonpublish.yml +++ b/.github/workflows/pythonpublish.yml @@ -6,7 +6,7 @@ on: permissions: id-token: write # This is required for requesting the JWT - contents: read + contents: write jobs: deploy: @@ -14,16 +14,19 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 + - uses: actions/checkout@v4 with: - node-version: 18 + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 'lts/*' - run: npx changelogithub continue-on-error: true env: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - - name: Set up Python 3.8 + + - name: Set up Python uses: actions/setup-python@v5 with: python-version: '3.12' From fa2d92927259980f82850acd41d1802dfe6ef1a1 Mon Sep 17 00:00:00 2001 From: Frost Ming Date: Thu, 11 Jul 2024 12:04:12 +0800 Subject: [PATCH 3/3] doc: fix the doc of lock groups selection Signed-off-by: Frost Ming --- doc/src/plugins/backend.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/src/plugins/backend.rst b/doc/src/plugins/backend.rst index 2dc6d8e..84f76e1 100644 --- a/doc/src/plugins/backend.rst +++ b/doc/src/plugins/backend.rst @@ -55,6 +55,7 @@ By default, the default group and all optional groups will be locked, but you ca .. code-block:: toml :caption: pyproject.toml + # for pdm-backend [tool.pdm.build] locked = true