From dce4166bc8a6a0ca407e1e74ee4efcd489315753 Mon Sep 17 00:00:00 2001 From: Trenton Holmes Date: Thu, 28 Apr 2022 11:20:40 -0700 Subject: [PATCH 1/3] First changes for using semver everywhere --- .github/workflows/ci.yml | 6 ++++++ docs/administration.rst | 17 +++++++++++++++++ docs/conf.py | 6 ++++-- src/documents/views.py | 29 +++++++++++++++++------------ src/paperless/middleware.py | 2 +- src/paperless/version.py | 9 ++++++++- 6 files changed, 53 insertions(+), 16 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fe52da55d..8fe71ac9a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -260,8 +260,14 @@ jobs: ghcr.io/${{ github.repository }} name=paperlessngx/paperless-ngx,enable=${{ steps.docker-hub.outputs.enable }} tags: | + # Tag branches with branch name type=ref,event=branch + # Tag tags with tag name type=ref,event=tag + # Process semver tags + # For a tag x.y.z or vX.Y.Z, output an x.y.z and x.y image tag + type=semver,pattern={{version}} + type=semver,pattern={{major}}.{{minor}} - name: Checkout uses: actions/checkout@v3 diff --git a/docs/administration.rst b/docs/administration.rst index 85f573460..1139c3a69 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -117,6 +117,23 @@ Then you can start paperless-ngx with ``-d`` to have it run in the background. image: ghcr.io/paperless-ngx/paperless-ngx:latest + .. note:: + In version 1.7.1 and onwards, the Docker image can now pinned to a release series. + This is often combined with automatic updaters such as Watchtower to allow safer + unattended upgrading to new bugfix releases only. It is still recommended to always + review release notes before upgrading. To ping your install to a release series, edit + the ``docker-compose.yml`` find the line that says + + .. code:: + + image: ghcr.io/paperless-ngx/paperless-ngx:latest + + and replace the version with the series you want to track, for example: + + .. code:: + + image: ghcr.io/paperless-ngx/paperless-ngx:1.7 + Bare Metal Route ================ diff --git a/docs/conf.py b/docs/conf.py index 19efbbdf8..0f30772ea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,6 +2,8 @@ import sphinx_rtd_theme __version__ = None +__full_version_str__ = None +__major_minor_version_str__ = None exec(open("../src/paperless/version.py").read()) @@ -41,9 +43,9 @@ copyright = "2015-2022, Daniel Quinn, Jonas Winkler, and the paperless-ngx team" # # The short X.Y version. -version = ".".join([str(_) for _ in __version__[:2]]) +version = __major_minor_version_str__ # The full version, including alpha/beta/rc tags. -release = ".".join([str(_) for _ in __version__[:3]]) +release = __full_version_str__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/src/documents/views.py b/src/documents/views.py index 831e68b68..d29802394 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -676,28 +676,33 @@ class RemoteVersionView(GenericAPIView): def get(self, request, format=None): remote_version = "0.0.0" is_greater_than_current = False + current_version = packaging_version.parse(version.__full_version_str__) # TODO: this can likely be removed when frontend settings are saved to DB feature_is_set = settings.ENABLE_UPDATE_CHECK != "default" if feature_is_set and settings.ENABLE_UPDATE_CHECK: try: - with urllib.request.urlopen( - "https://api.github.com/repos/" - + "paperless-ngx/paperless-ngx/releases/latest", - ) as response: + req = urllib.request.Request( + "https://api.github.com/repos/paperless-ngx/" + "paperless-ngx/releases/latest", + ) + # Ensure a JSON response + req.add_header("Accept", "application/json") + + with urllib.request.urlopen(req) as response: remote = response.read().decode("utf-8") try: remote_json = json.loads(remote) - remote_version = remote_json["tag_name"].replace("ngx-", "") + remote_version = remote_json["tag_name"].removeprefix("ngx-") except ValueError: - logger.debug("An error occured parsing remote version json") + logger.debug("An error occurred parsing remote version json") except urllib.error.URLError: - logger.debug("An error occured checking for available updates") + logger.debug("An error occurred checking for available updates") - current_version = ".".join([str(_) for _ in version.__version__[:3]]) - is_greater_than_current = packaging_version.parse( - remote_version, - ) > packaging_version.parse( - current_version, + is_greater_than_current = ( + packaging_version.parse( + remote_version, + ) + > current_version ) return Response( diff --git a/src/paperless/middleware.py b/src/paperless/middleware.py index f82ba2435..ddf12812b 100644 --- a/src/paperless/middleware.py +++ b/src/paperless/middleware.py @@ -11,6 +11,6 @@ class ApiVersionMiddleware: if request.user.is_authenticated: versions = settings.REST_FRAMEWORK["ALLOWED_VERSIONS"] response["X-Api-Version"] = versions[len(versions) - 1] - response["X-Version"] = ".".join([str(_) for _ in version.__version__]) + response["X-Version"] = version.__full_version_str__ return response diff --git a/src/paperless/version.py b/src/paperless/version.py index 8c908319f..44d20435a 100644 --- a/src/paperless/version.py +++ b/src/paperless/version.py @@ -1 +1,8 @@ -__version__ = (1, 7, 0) +from typing import Final +from typing import Tuple + +__version__: Final[Tuple[int, int, int]] = (1, 7, 0) +# Version string like X.Y.Z +__full_version_str__: Final[str] = ".".join(map(str, __version__)) +# Version string like X.Y +__major_minor_version_str__: Final[str] = ".".join(map(str, __version__[:-1])) From b9a2652013773eb0f5e92540ec68b9fbd3516a07 Mon Sep 17 00:00:00 2001 From: Trenton Holmes Date: Thu, 28 Apr 2022 13:44:37 -0700 Subject: [PATCH 2/3] Fixing up more locations of the old tag naming style --- .github/release-drafter.yml | 1 - .github/workflows/ci.yml | 17 +++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index d3e2e165f..b52e08f35 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -30,7 +30,6 @@ replacers: # Changes "Feature: Update checker" to "Update checker" replace: '' change-template: '- $TITLE @$AUTHOR (#$NUMBER)' change-title-escapes: '\<*_&#@' -tag-prefix: "ngx-" template: | # Changelog diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8fe71ac9a..980a3570a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,8 +3,9 @@ name: ci on: push: tags: - - ngx-* - - beta-* + - 'v[0-9]+.[0-9]+.[0-9]+' + - 'v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+' + - 'beta-[0-9]+.[0-9]+.[0-9]+-rc[0-9]+' branches-ignore: - 'translations**' pull_request: @@ -53,7 +54,7 @@ jobs: prepare-docker-build: name: Prepare Docker Pipeline Data - if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/beta' || startsWith(github.ref, 'refs/tags/ngx-') || startsWith(github.ref, 'refs/tags/beta-')) + if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/beta' || startsWith(github.ref, 'refs/tags/v') || startsWith(github.ref, 'refs/tags/beta-')) runs-on: ubuntu-20.04 needs: - documentation @@ -388,7 +389,7 @@ jobs: runs-on: ubuntu-20.04 needs: - build-release - if: github.ref_type == 'tag' && (startsWith(github.ref_name, 'ngx-') || startsWith(github.ref_name, 'beta-')) + if: github.ref_type == 'tag' && (startsWith(github.ref_name, 'v') || startsWith(github.ref_name, 'beta-')) steps: - name: Download release artifact @@ -400,11 +401,11 @@ jobs: name: Get version id: get_version run: | - if [[ $GITHUB_REF == refs/tags/ngx-* ]]; then - echo ::set-output name=version::${GITHUB_REF#refs/tags/ngx-} + if [[ $GITHUB_REF == refs/tags/v* ]]; then + echo ::set-output name=version::${{ github.ref_name }} echo ::set-output name=prerelease::false elif [[ $GITHUB_REF == refs/tags/beta-* ]]; then - echo ::set-output name=version::${GITHUB_REF#refs/tags/beta-} + echo ::set-output name=version::${{ github.ref_name }} echo ::set-output name=prerelease::true fi - @@ -413,7 +414,7 @@ jobs: uses: release-drafter/release-drafter@v5 with: name: Paperless-ngx ${{ steps.get_version.outputs.version }} - tag: ngx-${{ steps.get_version.outputs.version }} + tag: ${{ steps.get_version.outputs.version }} version: ${{ steps.get_version.outputs.version }} prerelease: ${{ steps.get_version.outputs.prerelease }} publish: true # ensures release is not marked as draft From 2ef2a561efcfd823223220896d8f64cde38ca7eb Mon Sep 17 00:00:00 2001 From: Trenton Holmes Date: Sun, 1 May 2022 13:58:24 -0700 Subject: [PATCH 3/3] Fixes beta or rcs from updating the latest Docker tag --- .github/workflows/ci.yml | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 980a3570a..bbbc12032 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,9 +3,10 @@ name: ci on: push: tags: + # https://semver.org/#spec-item-2 - 'v[0-9]+.[0-9]+.[0-9]+' - - 'v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+' - - 'beta-[0-9]+.[0-9]+.[0-9]+-rc[0-9]+' + # https://semver.org/#spec-item-9 + - 'v[0-9]+.[0-9]+.[0-9]+-beta.rc[0-9]+' branches-ignore: - 'translations**' pull_request: @@ -54,7 +55,7 @@ jobs: prepare-docker-build: name: Prepare Docker Pipeline Data - if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/beta' || startsWith(github.ref, 'refs/tags/v') || startsWith(github.ref, 'refs/tags/beta-')) + if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/beta' || contains(github.ref, 'beta.rc') || startsWith(github.ref, 'refs/tags/v')) runs-on: ubuntu-20.04 needs: - documentation @@ -263,8 +264,6 @@ jobs: tags: | # Tag branches with branch name type=ref,event=branch - # Tag tags with tag name - type=ref,event=tag # Process semver tags # For a tag x.y.z or vX.Y.Z, output an x.y.z and x.y image tag type=semver,pattern={{version}} @@ -389,7 +388,7 @@ jobs: runs-on: ubuntu-20.04 needs: - build-release - if: github.ref_type == 'tag' && (startsWith(github.ref_name, 'v') || startsWith(github.ref_name, 'beta-')) + if: github.ref_type == 'tag' && (startsWith(github.ref_name, 'v') || contains(github.ref_name, '-beta.rc')) steps: - name: Download release artifact @@ -401,12 +400,11 @@ jobs: name: Get version id: get_version run: | - if [[ $GITHUB_REF == refs/tags/v* ]]; then - echo ::set-output name=version::${{ github.ref_name }} - echo ::set-output name=prerelease::false - elif [[ $GITHUB_REF == refs/tags/beta-* ]]; then - echo ::set-output name=version::${{ github.ref_name }} + echo ::set-output name=version::${{ github.ref_name }} + if [[ ${{ contains(github.ref_name, '-beta.rc') }} == 'true' ]]; then echo ::set-output name=prerelease::true + else + echo ::set-output name=prerelease::false fi - name: Create Release and Changelog