chore: Release 1.1.0 (#1210)

* chore: Release 1.1.0 * [pre-commit.ci] auto fixes * Update dev dependencies * Update dev dependencies * Update versions list * Apply suggestions from code review * Update test_rpc_client.py --------- Co-authored-by: edgarrmondragon <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Edgar Ramírez-Mondragón <[email protected]>
edgarrmondragon · Oct 30, 2024 · 806a97b · 806a97b
1 parent b9af7a3
commit 806a97b
Show file tree

Hide file tree

Showing 19 changed files with 62 additions and 56 deletions.
diff --git a/.changes/1.1.0.md b/.changes/1.1.0.md
@@ -0,0 +1,15 @@
+## 1.1.0 - 2024-10-29
+
+### Added
+
+- [#1153](https://github.com/edgarrmondragon/citric/issues/1153) Added `name` and `description` parameters to `import_group` RPC method
+- [#1190](https://github.com/edgarrmondragon/citric/issues/1190) Added a new `RESTClient` method to refresh the session token
+- [#1201](https://github.com/edgarrmondragon/citric/issues/1201) Official support for Python 3.13
+
+### Refactored
+
+- [#1189](https://github.com/edgarrmondragon/citric/issues/1189) Test and document new top-level question attributes from LimeSurvey 6.6.3+
+
+### Documentation
+
+- [#1199](https://github.com/edgarrmondragon/citric/issues/1199) Updated the contributing guide to reflect current workflow
diff --git a/.changes/unreleased/Added-20240528-231314.yaml b/.changes/unreleased/Added-20240528-231314.yaml
diff --git a/.changes/unreleased/Added-20240921-220814.yaml b/.changes/unreleased/Added-20240921-220814.yaml
diff --git a/.changes/unreleased/Added-20241008-111016.yaml b/.changes/unreleased/Added-20241008-111016.yaml
diff --git a/.changes/unreleased/Documentation-20241008-130634.yaml b/.changes/unreleased/Documentation-20241008-130634.yaml
diff --git a/.changes/unreleased/Refactored-20240921-212214.yaml b/.changes/unreleased/Refactored-20240921-212214.yaml
diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml
@@ -15,7 +15,7 @@ body:
     attributes:
       label: Citric Version
       description: Version of the package you are using
-      placeholder: "1.0.1"
+      placeholder: "1.1.0"
     validations:
       required: true
   - type: dropdown

diff --git a/.github/workflows/api-changes.yml b/.github/workflows/api-changes.yml
@@ -23,12 +23,12 @@ jobs:
       NOXSESSION: api
     steps:
     - name: Check out the repository
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         fetch-depth: 0
 
     - name: Setup Python
-      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
         python-version: 3.x
 

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -20,7 +20,7 @@ jobs:
     name: Build wheel and sdist
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         fetch-depth: 0
         ref: ${{ github.event.inputs.tag || github.ref }}

diff --git a/.github/workflows/gen-release-pr.yml b/.github/workflows/gen-release-pr.yml
@@ -28,7 +28,7 @@ jobs:
       pull-requests: write  # to create and update PRs
       discussions: write    # to create a discussion
     steps:
-    - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Batch changes
       uses: miniscruff/changie-action@6dcc2533cac0495148ed4046c438487e4dceaa23 # v2.0.0
       with:

diff --git a/.github/workflows/gha-update.yml b/.github/workflows/gha-update.yml
@@ -14,8 +14,8 @@ jobs:
     permissions:
       pull-requests: write  # to create and update PRs
     steps:
-    - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
-    - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
         python-version: '3.x'
     - uses: hynek/setup-cached-uv@3e2b834ff80f67c4f272449b9f1aa388c294ae48 # v2.2.1

diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -33,7 +33,7 @@ jobs:
 
     steps:
     - name: "Checkout code"
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         persist-credentials: false
 
@@ -60,14 +60,14 @@ jobs:
     # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
     # format to the repository Actions tab.
     - name: "Upload artifact"
-      uses: actions/upload-artifact@604373da6381bf24206979c74d06a550515601b9 # v4.4.1
+      uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
       with:
         name: SARIF file
         path: results.sarif
         retention-days: 5
 
     # Upload the results to GitHub's code scanning dashboard.
     - name: "Upload to code-scanning"
-      uses: github/codeql-action/upload-sarif@c36620d31ac7c881962c3d9dd939c40ec9434f2b # v3.26.12
+      uses: github/codeql-action/upload-sarif@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
       with:
         sarif_file: results.sarif
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -80,13 +80,13 @@ jobs:
 
     steps:
     - name: Check out the repository
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         fetch-tags: true
 
     - name: Setup Python ${{ matrix.python-version }}
       if: "${{ !matrix.nightly }}"
-      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64
@@ -110,7 +110,7 @@ jobs:
         nox --verbose -s tests
 
     - name: Upload coverage data
-      uses: actions/upload-artifact@604373da6381bf24206979c74d06a550515601b9 # v4.4.1
+      uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
       with:
         include-hidden-files: true
         name: "coverage-unit-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.nightly && 'nightly' || 'stable' }}"
@@ -135,10 +135,10 @@ jobs:
       tags: ${{ steps.tags.outputs.tags }}
     steps:
     - name: Check out the repository
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Setup Python
-      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
         python-version: 3.x
         architecture: x64
@@ -174,7 +174,7 @@ jobs:
       engines: ${{ steps.engines.outputs.engines }}
     steps:
     - name: Check out the repository
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Test against all engines
       if: ${{ contains(github.event.pull_request.labels.*.name, 'Release') || inputs.all_integrations || github.event_name == 'schedule' }}
@@ -259,12 +259,12 @@ jobs:
 
     steps:
     - name: Check out the repository
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         fetch-tags: true
 
     - name: Setup Python ${{ matrix.python-version }}
-      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64
@@ -316,7 +316,7 @@ jobs:
 
     - name: Upload coverage data
       if: always()
-      uses: actions/upload-artifact@604373da6381bf24206979c74d06a550515601b9 # v4.4.1
+      uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
       with:
         include-hidden-files: true
         name: "coverage-integration-${{ matrix.python-version }}-${{ matrix.image_tag || env.LS_CHECKSUM }}-${{ matrix.database }}"
@@ -334,10 +334,10 @@ jobs:
       fail-fast: false
     steps:
     - name: Check out the repository
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Set up Python
-      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
         python-version: "3.x"
         cache: pip

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,7 +28,7 @@ repos:
   - id: check-readthedocs
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.6.9
+  rev: v0.7.1
   hooks:
   - id: ruff
     args: [--fix, --exit-non-zero-on-fix, --show-fixes]
@@ -63,12 +63,12 @@ repos:
     args: [--all]
 
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: "2.3.0"
+  rev: "v2.4.3"
   hooks:
   - id: pyproject-fmt
 
 - repo: https://github.com/astral-sh/uv-pre-commit
-  rev: 0.4.20
+  rev: 0.4.28
   hooks:
   - id: pip-compile
     files: ^pyproject\.toml$

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 and is generated by [Changie](https://github.com/miniscruff/changie).
 
+## 1.1.0 - 2024-10-29
+
+### Added
+
+- [#1153](https://github.com/edgarrmondragon/citric/issues/1153) Added `name` and `description` parameters to `import_group` RPC method
+- [#1190](https://github.com/edgarrmondragon/citric/issues/1190) Added a new `RESTClient` method to refresh the session token
+- [#1201](https://github.com/edgarrmondragon/citric/issues/1201) Official support for Python 3.13
+
+### Refactored
+
+- [#1189](https://github.com/edgarrmondragon/citric/issues/1189) Test and document new top-level question attributes from LimeSurvey 6.6.3+
+
+### Documentation
+
+- [#1199](https://github.com/edgarrmondragon/citric/issues/1199) Updated the contributing guide to reflect current workflow
+
 ## 1.0.1 - 2024-06-12
 
 ### Fixed

diff --git a/CITATION.cff b/CITATION.cff
@@ -5,7 +5,7 @@ authors:
   given-names: "Edgar"
   orcid: "https://orcid.org/0000-0002-4182-0385"
 title: "Citric"
-version: "1.0.1"
+version: "1.1.0"
 doi: 10.5281/zenodo.10216279
 date-released: 2021-11-11
 url: "https://github.com/edgarrmondragon/citric"
diff --git a/docs/index.md b/docs/index.md
@@ -22,9 +22,9 @@ Release **v{sub-ref}`version`**. ([What's new?](./changelog.md))
 
 Integration tests are run against a LimeSurvey instance, and both PostgreSQL and MySQL backends, using Docker Compose. The following versions of LimeSurvey were tested for this release:
 
+- {ls_tag}`6.6.6+241002`
 - {ls_tag}`6.6.5+240924`
 - {ls_tag}`6.6.4+240923`
-- {ls_tag}`6.6.3+240909`
 - {ls_tag}`5.6.68+240625`
 - {ls_tag}`5.6.67+240612`
 - {ls_tag}`5.6.66+240604`

diff --git a/src/citric/client.py b/src/citric/client.py
@@ -1257,7 +1257,7 @@ def import_group(
                 group_id = client.import_group(f, survey_id)
 
         .. versionadded:: 0.0.10
-        .. versionchanged:: NEXT_VERSION
+        .. versionchanged:: 1.1.0
            Added the ``name`` and ``description`` optional parameters.
         """
         contents = base64.b64encode(file.read()).decode()

diff --git a/tests/integration/test_rpc_client.py b/tests/integration/test_rpc_client.py
@@ -276,9 +276,9 @@ def test_import_group_with_name(
     """Test importing a group with a custom name."""
     request.applymarker(
         pytest.mark.xfail(
-            server_version < semver.VersionInfo.parse("6.6.6"),
+            server_version < semver.VersionInfo.parse("6.6.7"),
             reason=(
-                f"The name override is broken in LimeSurvey {server_version} < 6.6.0"
+                f"The name override is broken in LimeSurvey {server_version} < 6.6.7"
             ),
             strict=True,
         ),
@@ -301,10 +301,10 @@ def test_import_group_with_description(
     """Test importing a group with a custom description."""
     request.applymarker(
         pytest.mark.xfail(
-            server_version < semver.VersionInfo.parse("6.6.6"),
+            server_version < semver.VersionInfo.parse("6.6.7"),
             reason=(
                 "The description override is broken in LimeSurvey "
-                f"{server_version} < 6.6.0"
+                f"{server_version} < 6.6.7"
             ),
             strict=True,
         ),