From 25294f2266f9a2e8fdb6c5284719a3eb0b98a82f Mon Sep 17 00:00:00 2001 From: pulpbot Date: Wed, 5 Jun 2024 10:27:41 +0000 Subject: [PATCH] Update CI files [noissue] --- .ci/scripts/collect_changes.py | 8 +- .github/template_gitref | 2 +- .github/workflows/build.yml | 5 +- .github/workflows/changelog.yml | 2 +- .github/workflows/ci.yml | 7 +- .github/workflows/create-branch.yml | 2 +- .github/workflows/lint.yml | 2 +- .github/workflows/nightly.yml | 10 +- .github/workflows/publish.yml | 43 +-- .github/workflows/release.yml | 2 +- .github/workflows/scripts/before_script.sh | 6 - .../workflows/scripts/publish_client_pypi.sh | 10 +- .github/workflows/test.yml | 23 +- .github/workflows/update-labels.yml | 2 +- .github/workflows/update_ci.yml | 2 +- CHANGES.md | 195 +++++++++++++ CHANGES.rst | 266 ------------------ CHANGES/.TEMPLATE.md | 39 +++ MANIFEST.in | 2 +- docs/changes.rst | 7 +- docs/conf.py | 5 + docs/template_gitref | 2 +- pyproject.toml | 10 +- 23 files changed, 319 insertions(+), 333 deletions(-) create mode 100644 CHANGES.md delete mode 100644 CHANGES.rst create mode 100644 CHANGES/.TEMPLATE.md diff --git a/.ci/scripts/collect_changes.py b/.ci/scripts/collect_changes.py index e7d24c81..c73efe2d 100755 --- a/.ci/scripts/collect_changes.py +++ b/.ci/scripts/collect_changes.py @@ -1,3 +1,4 @@ +#!/bin/env python3 # WARNING: DO NOT EDIT! # # This file was generated by plugin_template, and is managed by it. Please use @@ -8,13 +9,14 @@ import itertools import os import re +import tomllib -import toml from git import GitCommandError, Repo from packaging.version import parse as parse_version # Read Towncrier settings -tc_settings = toml.load("pyproject.toml")["tool"]["towncrier"] +with open("pyproject.toml", "rb") as fp: + tc_settings = tomllib.load(fp)["tool"]["towncrier"] CHANGELOG_FILE = tc_settings.get("filename", "NEWS.rst") START_STRING = tc_settings.get( @@ -79,7 +81,7 @@ def main(): old_length = len(main_changes) for branch in branches: - print(f"Looking at branch {branch}") + print(f"Looking for './{CHANGELOG_FILE}' at branch {branch}") try: changelog = get_changelog(repo, branch) except GitCommandError: diff --git a/.github/template_gitref b/.github/template_gitref index 2f00223c..dadaa1c9 100644 --- a/.github/template_gitref +++ b/.github/template_gitref @@ -1 +1 @@ -2021.08.26-328-g59a6718 +2021.08.26-338-g2237db8 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c615655f..f035a017 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -23,7 +23,7 @@ jobs: with: fetch-depth: 1 path: "pulp_ostree" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" - name: "Install python dependencies" @@ -36,9 +36,10 @@ jobs: python3 setup.py sdist bdist_wheel --python-tag py3 twine check dist/* - name: "Upload Package whl" - uses: "actions/upload-artifact@v3" + uses: "actions/upload-artifact@v4" with: name: "plugin_package" path: "pulp_ostree/dist/" if-no-files-found: "error" retention-days: 5 + overwrite: true diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index c86f9a76..baeba1d3 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -28,7 +28,7 @@ jobs: with: fetch-depth: 1 - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cd2ea0d1..f9369f60 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -25,7 +25,7 @@ jobs: with: fetch-depth: 0 path: "pulp_ostree" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" - name: "Install python dependencies" @@ -67,10 +67,11 @@ jobs: mkdir -p "pulp_ostree" working-directory: "." - name: "Download Deprecations" - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: - name: "deprecations" + pattern: "deprecations-*" path: "pulp_ostree" + merge-multiple: true - name: "Print deprecations" run: | cat deprecations-*.txt | sort -u diff --git a/.github/workflows/create-branch.yml b/.github/workflows/create-branch.yml index 45153c52..f5a81923 100644 --- a/.github/workflows/create-branch.yml +++ b/.github/workflows/create-branch.yml @@ -26,7 +26,7 @@ jobs: fetch-depth: 0 path: "pulp_ostree" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index b3c11735..b00b3987 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -24,7 +24,7 @@ jobs: fetch-depth: 1 path: "pulp_ostree" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 946bd25f..b7ccf055 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -38,7 +38,7 @@ jobs: fetch-depth: 0 path: "pulp_ostree" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" @@ -76,12 +76,12 @@ jobs: fetch-depth: 1 path: "pulp_ostree" - - uses: actions/download-artifact@v3 + - uses: actions/download-artifact@v4 with: name: "plugin_package" path: "pulp_ostree/dist/" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" @@ -96,13 +96,13 @@ jobs: echo "TEST=${{ matrix.env.TEST }}" >> $GITHUB_ENV - name: Download built docs - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: "docs.tar" path: "pulp_ostree" - name: Download Python client docs - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: "python-client-docs.tar" path: "pulp_ostree" diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index fe20c2fe..011e2892 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -39,11 +39,11 @@ jobs: repository: "pulp/pulp-openapi-generator" path: "pulp-openapi-generator" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" - - uses: "actions/download-artifact@v3" + - uses: "actions/download-artifact@v4" with: name: "plugin_package" path: "pulp_ostree/dist/" @@ -88,25 +88,32 @@ jobs: run: | .github/workflows/scripts/install_ruby_client.sh shell: "bash" + - name: "Upload python client packages" - uses: "actions/upload-artifact@v3" + uses: "actions/upload-artifact@v4" with: name: "python-client.tar" - path: "pulp_ostree/ostree-python-client.tar" + path: | + pulp_ostree/ostree-python-client.tar if-no-files-found: "error" + overwrite: true - name: "Upload python client docs" - uses: "actions/upload-artifact@v3" + uses: "actions/upload-artifact@v4" with: name: "python-client-docs.tar" - path: "pulp_ostree/ostree-python-client-docs.tar" + path: | + pulp_ostree/ostree-python-client-docs.tar if-no-files-found: "error" + overwrite: true - name: "Upload ruby client packages" - uses: "actions/upload-artifact@v3" + uses: "actions/upload-artifact@v4" with: name: "ruby-client.tar" - path: "pulp_ostree/ostree-ruby-client.tar" + path: | + pulp_ostree/ostree-ruby-client.tar if-no-files-found: "error" + overwrite: true - name: Build docs run: | export DJANGO_SETTINGS_MODULE=pulpcore.app.settings @@ -115,10 +122,12 @@ jobs: tar -cvf docs/docs.tar docs/_build - name: "Upload built docs" - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "docs.tar" path: "pulp_ostree/docs/docs.tar" + if-no-files-found: "error" + overwrite: true - name: "Logs" if: always() @@ -145,12 +154,12 @@ jobs: fetch-depth: 1 path: "pulp_ostree" - - uses: "actions/download-artifact@v3" + - uses: "actions/download-artifact@v4" with: name: "plugin_package" path: "pulp_ostree/dist/" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" @@ -184,7 +193,7 @@ jobs: path: "pulp_ostree" - name: "Download Python client" - uses: "actions/download-artifact@v3" + uses: "actions/download-artifact@v4" with: name: "python-client.tar" path: "pulp_ostree/" @@ -193,7 +202,7 @@ jobs: run: | tar -xvf ostree-python-client.tar - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" @@ -227,7 +236,7 @@ jobs: path: "pulp_ostree" - name: "Download Ruby client" - uses: "actions/download-artifact@v3" + uses: "actions/download-artifact@v4" with: name: "ruby-client.tar" path: "pulp_ostree/" @@ -263,7 +272,7 @@ jobs: fetch-depth: 1 path: "pulp_ostree" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" @@ -280,13 +289,13 @@ jobs: SECRETS_CONTEXT: "${{ toJson(secrets) }}" - name: "Download built docs" - uses: "actions/download-artifact@v3" + uses: "actions/download-artifact@v4" with: name: "docs.tar" path: "pulp_ostree/" - name: "Download Python client docs" - uses: "actions/download-artifact@v3" + uses: "actions/download-artifact@v4" with: name: "python-client-docs.tar" path: "pulp_ostree/" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 547e67c9..13cf26e1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -28,7 +28,7 @@ jobs: path: "pulp_ostree" token: ${{ secrets.RELEASE_TOKEN }} - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" diff --git a/.github/workflows/scripts/before_script.sh b/.github/workflows/scripts/before_script.sh index edc459e5..be3737d8 100755 --- a/.github/workflows/scripts/before_script.sh +++ b/.github/workflows/scripts/before_script.sh @@ -36,12 +36,6 @@ tail -v -n +1 .ci/ansible/Containerfile cmd_prefix bash -c "echo '%wheel ALL=(ALL) NOPASSWD: ALL' > /etc/sudoers.d/nopasswd" cmd_prefix bash -c "usermod -a -G wheel pulp" -SCENARIOS=("pulp" "performance" "azure" "gcp" "s3" "generate-bindings" "lowerbounds") -if [[ " ${SCENARIOS[*]} " =~ " ${TEST} " ]]; then - # Many functional tests require these - cmd_prefix dnf install -yq lsof which -fi - if [[ "${REDIS_DISABLED:-false}" == true ]]; then cmd_prefix bash -c "s6-rc -d change redis" echo "The Redis service was disabled for $TEST" diff --git a/.github/workflows/scripts/publish_client_pypi.sh b/.github/workflows/scripts/publish_client_pypi.sh index 65c91b1f..090e01fa 100755 --- a/.github/workflows/scripts/publish_client_pypi.sh +++ b/.github/workflows/scripts/publish_client_pypi.sh @@ -24,10 +24,8 @@ RESPONSE="$(curl --write-out '%{http_code}' --silent --output /dev/null "https:/ if [ "$RESPONSE" == "200" ]; then echo "pulp_ostree client $VERSION has already been released. Skipping." - exit +else + twine upload -u __token__ -p "$PYPI_API_TOKEN" \ + "dist/pulp_ostree_client-$VERSION-py3-none-any.whl" \ + "dist/pulp_ostree-client-$VERSION.tar.gz" fi - -twine upload -u __token__ -p "$PYPI_API_TOKEN" \ -"dist/pulp_ostree_client-$VERSION-py3-none-any.whl" \ -"dist/pulp_ostree-client-$VERSION.tar.gz" \ -; diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9d1e4c7c..205b82bf 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -39,11 +39,11 @@ jobs: repository: "pulp/pulp-openapi-generator" path: "pulp-openapi-generator" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" - - uses: "actions/download-artifact@v3" + - uses: "actions/download-artifact@v4" with: name: "plugin_package" path: "pulp_ostree/dist/" @@ -119,43 +119,50 @@ jobs: docker logs pulp 2>&1 | grep -i pulpcore.deprecation | tee deprecations-${{ matrix.env.TEST }}.txt - name: "Upload Deprecations" - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: - name: "deprecations" + name: "deprecations-${{ matrix.env.TEST }}" path: "pulp_ostree/deprecations-${{ matrix.env.TEST }}.txt" if-no-files-found: "error" retention-days: 5 + overwrite: true - name: Upload python client packages if: ${{ env.TEST == 'pulp' }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "python-client.tar" path: "pulp_ostree/ostree-python-client.tar" if-no-files-found: "error" retention-days: 5 + overwrite: true - name: Upload python client docs if: ${{ env.TEST == 'pulp' }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "python-client-docs.tar" path: "pulp_ostree/ostree-python-client-docs.tar" if-no-files-found: "error" retention-days: 5 + overwrite: true - name: Upload Ruby client if: ${{ env.TEST == 'pulp' }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "ruby-client.tar" path: "pulp_ostree/ostree-ruby-client.tar" if-no-files-found: "error" retention-days: 5 + overwrite: true - name: Upload built docs if: ${{ env.TEST == 'docs' }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "docs.tar" path: "pulp_ostree/docs/docs.tar" + if-no-files-found: "error" + retention-days: 5 + overwrite: true - name: "Logs" if: always() diff --git a/.github/workflows/update-labels.yml b/.github/workflows/update-labels.yml index 94a6a8c9..9295f444 100644 --- a/.github/workflows/update-labels.yml +++ b/.github/workflows/update-labels.yml @@ -19,7 +19,7 @@ jobs: update_backport_labels: runs-on: "ubuntu-latest" steps: - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" - name: "Configure Git with pulpbot name and email" diff --git a/.github/workflows/update_ci.yml b/.github/workflows/update_ci.yml index 0d376853..48e72129 100644 --- a/.github/workflows/update_ci.yml +++ b/.github/workflows/update_ci.yml @@ -29,7 +29,7 @@ jobs: repository: "pulp/plugin_template" path: "plugin_template" - - uses: "actions/setup-python@v4" + - uses: "actions/setup-python@v5" with: python-version: "3.11" diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 00000000..8fcbeaf9 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,195 @@ +# Changelog + +[//]: # (You should *NOT* be adding new change log entries to this file, this) +[//]: # (file is managed by towncrier. You *may* edit previous change logs to) +[//]: # (fix problems like typo corrections or such.) +[//]: # (To add a new change log entry, please see the contributing docs.) +[//]: # (WARNING: Don't drop the towncrier directive!) + +[//]: # (towncrier release notes start) + +## 2.3.0 (2024-02-19) {: #2.3.0 } + +### Features + +- Added support for domains. + [#321](https://github.com/pulp/pulp_ostree/issues/321) +- Added role-based access control. + [#331](https://github.com/pulp/pulp_ostree/issues/331) + +### Bugfixes + +- Improved the performance of subsequent imports. + [#289](https://github.com/pulp/pulp_ostree/issues/289) + +### Misc + +- [#324](https://github.com/pulp/pulp_ostree/issues/324), [#325](https://github.com/pulp/pulp_ostree/issues/325), [#326](https://github.com/pulp/pulp_ostree/issues/326), [#327](https://github.com/pulp/pulp_ostree/issues/327) + +--- + +## 2.2.1 (2023-11-16) {: #2.2.1 } + +### Bugfixes + +- Improved the performance of subsequent imports. + [#289](https://github.com/pulp/pulp_ostree/issues/289) + +--- + +## 2.2.0 (2023-11-03) {: #2.2.0 } + +### Features + +- Made plugin compatible with pulpcore 3.40.1+. + [#303](https://github.com/pulp/pulp_ostree/issues/303) + +### Bugfixes + +- Started re-generating summary files and publishing them during the import. + [#269](https://github.com/pulp/pulp_ostree/issues/269) +- Fixed a bug that led to ignoring already imported refs in a repository when generating a summary. + [#277](https://github.com/pulp/pulp_ostree/issues/277) +- Made the import facility to accept tarballs with already imported parent commits. + [#279](https://github.com/pulp/pulp_ostree/issues/279) +- Fixed the procedure of regenerating summaries by using the relevant refs only. + [#288](https://github.com/pulp/pulp_ostree/issues/288) + +--- + +## 2.1.3 (2023-09-18) {: #2.1.3 } + +### Bugfixes + +- Fixed the procedure of regenerating summaries by using the relevant refs only. + [#288](https://github.com/pulp/pulp_ostree/issues/288) + +--- + +## 2.1.2 (2023-09-11) {: #2.1.2 } + +### Bugfixes + +- Fixed a bug that led to ignoring already imported refs in a repository when generating a summary. + [#277](https://github.com/pulp/pulp_ostree/issues/277) +- Made the import facility to accept tarballs with already imported parent commits. + [#279](https://github.com/pulp/pulp_ostree/issues/279) + +--- + +## 2.1.1 (2023-07-12) {: #2.1.1 } + +### Bugfixes + +- Started re-generating summary files and publishing them during the import. + [#269](https://github.com/pulp/pulp_ostree/issues/269) + +--- + +## 2.1.0 (2023-05-28) {: #2.1.0 } + +### Features + +- Made the plugin compatible with Django 4.2 and pulpcore 3.25. + [#258](https://github.com/pulp/pulp_ostree/issues/258) + +### Bugfixes + +- Fixed the path resolution when a user specifies absolute paths when importing repositories. + [#226](https://github.com/pulp/pulp_ostree/issues/226) +- Fixed a bug that disallowed users to pull re-synced content locally. + [#257](https://github.com/pulp/pulp_ostree/issues/257) +- Fixed a bug which prevented users from assigning remotes to repositories in advance. + [#262](https://github.com/pulp/pulp_ostree/issues/262) + +--- + +## 2.0.0 (2023-03-30) {: #2.0.0 } + +### Features + +- Added support for third-party storage backends (i.e., S3, Azure). + [#172](https://github.com/pulp/pulp_ostree/issues/172) +- Added support for static deltas. The static deltas are automatically computed for synced and + imported repositories. This behaviour is enabled by default. Set `compute_delta` to `False` + in a corresponding repository if there is no need to compute the static deltas between the last + two commits. + [#230](https://github.com/pulp/pulp_ostree/issues/230) + +--- + +## 2.0.0a6 (2022-06-24) + +### Features + +- Added support for filtering refs during synchronization. Users can now use the flags + `include_refs` or `exclude_refs` to include or exclude refs from a remote repository. + [#163](https://github.com/pulp/pulp_ostree/issues/163) +- The old endpoint for importing a whole OSTree repository, including refs, was renamed to + `import_all`. The endpoint `import_commits` shall be now used to import commits to an existing + ref. + [#170](https://github.com/pulp/pulp_ostree/issues/170) + +### Improved Documentation + +- Added a new paragraph about filtering remote content by refs. + [#179](https://github.com/pulp/pulp_ostree/issues/179) + +--- + +## 2.0.0a5 (2022-02-12) + +No significant changes. + +--- + +## 2.0.0a4 (2022-01-12) + +No significant changes. + +--- + +## 2.0.0a3 (2022-01-11) + +### Features + +- The reference to a parent commit is now retrieved from a child commit automatically. + [#140](https://github.com/pulp/pulp_ostree/issues/140) + +### Bugfixes + +- Fixed content paths for published distributions. + [#143](https://github.com/pulp/pulp_ostree/issues/143) + +--- + +## 2.0.0a2 (2021-10-25) + +### Features + +- Added support for modifying repository content via the Pulp API. + [#8929](https://pulp.plan.io/issues/8929) +- Added support for filtering refs and commits by names and checksums, respectively. + [#9493](https://pulp.plan.io/issues/9493) + +### Bugfixes + +- Fixed a bug that disallowed users from publishing the same content in different repositories. + [#9431](https://pulp.plan.io/issues/9431) +- Fixed an issue that disallowed users from saving imported content. + [#9490](https://pulp.plan.io/issues/9490) + +--- + +## 2.0.0a1 (2021-09-08) + +### Features + +- Added support for uploading and publishing OSTree commits. + [#8918](https://pulp.plan.io/issues/8918) +- Added support for adding new commits to an existing repository. + [#8919](https://pulp.plan.io/issues/8919) +- Added support for syncing from remote OSTree repositories. + [#8921](https://pulp.plan.io/issues/8921) +- Verified support for deleting repository versions. + [#8922](https://pulp.plan.io/issues/8922) diff --git a/CHANGES.rst b/CHANGES.rst deleted file mode 100644 index 6c434c35..00000000 --- a/CHANGES.rst +++ /dev/null @@ -1,266 +0,0 @@ -========= -Changelog -========= - -.. - You should *NOT* be adding new change log entries to this file, this - file is managed by towncrier. You *may* edit previous change logs to - fix problems like typo corrections or such. - - WARNING: Don't drop the next directive! - -.. towncrier release notes start - -2.3.0 (2024-02-19) -================== - -Features --------- - -- Added support for domains. - `#321 `_ -- Added role-based access control. - `#331 `_ - - -Bugfixes --------- - -- Improved the performance of subsequent imports. - `#289 `_ - - -Misc ----- - -- `#324 `_, `#325 `_, `#326 `_, `#327 `_ - - ----- - - -2.2.1 (2023-11-16) -================== - -Bugfixes --------- - -- Improved the performance of subsequent imports. - `#289 `_ - - ----- - - -2.2.0 (2023-11-03) -================== - -Features --------- - -- Made plugin compatible with pulpcore 3.40.1+. - `#303 `_ - - -Bugfixes --------- - -- Started re-generating summary files and publishing them during the import. - `#269 `_ -- Fixed a bug that led to ignoring already imported refs in a repository when generating a summary. - `#277 `_ -- Made the import facility to accept tarballs with already imported parent commits. - `#279 `_ -- Fixed the procedure of regenerating summaries by using the relevant refs only. - `#288 `_ - - ----- - - -2.1.3 (2023-09-18) -================== - -Bugfixes --------- - -- Fixed the procedure of regenerating summaries by using the relevant refs only. - `#288 `_ - - ----- - - -2.1.2 (2023-09-11) -================== - -Bugfixes --------- - -- Fixed a bug that led to ignoring already imported refs in a repository when generating a summary. - `#277 `_ -- Made the import facility to accept tarballs with already imported parent commits. - `#279 `_ - - ----- - - -2.1.1 (2023-07-12) -================== - -Bugfixes --------- - -- Started re-generating summary files and publishing them during the import. - `#269 `_ - - ----- - - -2.1.0 (2023-05-28) -================== - -Features --------- - -- Made the plugin compatible with Django 4.2 and pulpcore 3.25. - `#258 `_ - - -Bugfixes --------- - -- Fixed the path resolution when a user specifies absolute paths when importing repositories. - `#226 `_ -- Fixed a bug that disallowed users to pull re-synced content locally. - `#257 `_ -- Fixed a bug which prevented users from assigning remotes to repositories in advance. - `#262 `_ - - ----- - - -2.0.0 (2023-03-30) -================== - -Features --------- - -- Added support for third-party storage backends (i.e., S3, Azure). - `#172 `_ -- Added support for static deltas. The static deltas are automatically computed for synced and - imported repositories. This behaviour is enabled by default. Set ``compute_delta`` to ``False`` - in a corresponding repository if there is no need to compute the static deltas between the last - two commits. - `#230 `_ - - ----- - - -2.0.0a6 (2022-06-24) -==================== - -Features --------- - -- Added support for filtering refs during synchronization. Users can now use the flags - ``include_refs`` or ``exclude_refs`` to include or exclude refs from a remote repository. - `#163 `_ -- The old endpoint for importing a whole OSTree repository, including refs, was renamed to - ``import_all``. The endpoint ``import_commits`` shall be now used to import commits to an existing - ref. - `#170 `_ - - -Improved Documentation ----------------------- - -- Added a new paragraph about filtering remote content by refs. - `#179 `_ - - ----- - - -2.0.0a5 (2022-02-12) -==================== - -No significant changes. - - ----- - - -2.0.0a4 (2022-01-12) -==================== - -No significant changes. - - ----- - - -2.0.0a3 (2022-01-11) -==================== - -Features --------- - -- The reference to a parent commit is now retrieved from a child commit automatically. - `#140 `_ - - -Bugfixes --------- - -- Fixed content paths for published distributions. - `#143 `_ - - ----- - - -2.0.0a2 (2021-10-25) -==================== - -Features --------- - -- Added support for modifying repository content via the Pulp API. - `#8929 `_ -- Added support for filtering refs and commits by names and checksums, respectively. - `#9493 `_ - - -Bugfixes --------- - -- Fixed a bug that disallowed users from publishing the same content in different repositories. - `#9431 `_ -- Fixed an issue that disallowed users from saving imported content. - `#9490 `_ - - ----- - - -2.0.0a1 (2021-09-08) -==================== - -Features --------- - -- Added support for uploading and publishing OSTree commits. - `#8918 `_ -- Added support for adding new commits to an existing repository. - `#8919 `_ -- Added support for syncing from remote OSTree repositories. - `#8921 `_ -- Verified support for deleting repository versions. - `#8922 `_ - - diff --git a/CHANGES/.TEMPLATE.md b/CHANGES/.TEMPLATE.md new file mode 100644 index 00000000..2308193b --- /dev/null +++ b/CHANGES/.TEMPLATE.md @@ -0,0 +1,39 @@ +{# TOWNCRIER TEMPLATE #} +{% for section, _ in sections.items() %} +{%- set section_slug = "-" + section|replace(" ", "-")|replace("_", "-")|lower %} +{%- if section %} + +### {{section}} {: #{{versiondata.version}}{{section_slug}} } +{% else %} +{%- set section_slug = "" %} +{% endif %} +{% if sections[section] %} +{% for category, val in definitions.items() if category in sections[section]%} + +#### {{ definitions[category]['name'] }} {: #{{versiondata.version}}{{section_slug}}-{{category}} } + +{% if definitions[category]['showcontent'] %} +{% for text, values in sections[section][category].items() %} +- {{ text }} +{% if values %} + {{ values|join(',\n ') }} +{% endif %} +{% endfor %} +{% else %} +- {{ sections[section][category]['']|join(', ') }} +{% endif %} +{% if sections[section][category]|length == 0 %} + +No significant changes. +{% else %} +{% endif %} +{% endfor %} +{% else %} + +No significant changes. +{% endif %} +{% endfor %} + +--- + + diff --git a/MANIFEST.in b/MANIFEST.in index 52ff1359..d9752938 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include CHANGES.rst +include CHANGES.md include COMMITMENT include COPYRIGHT include functest_requirements.txt diff --git a/docs/changes.rst b/docs/changes.rst index 86ad803c..96e8eb90 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -1,5 +1,4 @@ -.. _pulp_ostree-changes: +Changes +********* -.. include:: ../CHANGES.rst - -.. include:: ../HISTORY.rst +Removed due to docs migration process. diff --git a/docs/conf.py b/docs/conf.py index fd2e3dcf..3db63868 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -282,3 +282,8 @@ def find_obj(self, env, modname, classname, name, type, searchmode=0): def setup(sphinx): """Use MyPythonDomain in place of PythonDomain""" sphinx.add_domain(MyPythonDomain, override=True) + +rst_prolog = """.. attention:: + This documentation will be deactivated in the near future. `Learn More `_ + or go to the `New Pulp Docs `_ (beta). +""" diff --git a/docs/template_gitref b/docs/template_gitref index 2f00223c..dadaa1c9 100644 --- a/docs/template_gitref +++ b/docs/template_gitref @@ -1 +1 @@ -2021.08.26-328-g59a6718 +2021.08.26-338-g2237db8 diff --git a/pyproject.toml b/pyproject.toml index e4de7520..b3b80661 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,12 +7,14 @@ build-backend = 'setuptools.build_meta' [tool.towncrier] package = "pulp_ostree" -filename = "CHANGES.rst" +filename = "CHANGES.md" directory = "CHANGES/" -title_format = "{version} ({project_date})" -template = "CHANGES/.TEMPLATE.rst" +title_format = "## {version} ({project_date}) {{: #{version} }}" +template = "CHANGES/.TEMPLATE.md" -issue_format = "`#{issue} `_" +issue_format = "[#{issue}](https://github.com/pulp/pulp_ostree/issues/{issue})" +start_string = "[//]: # (towncrier release notes start)\n" +underlines = ["", "", ""] [[tool.towncrier.type]]