v5.3.1 Hotfix

Disclaimer

This is a hotfix release to fix the broken release v5.3.0. Sorry for the inconvenience.

What's Changed

• Remove contributors list from README #54 by @ChiefGokhlayeh in #55
• Fixed docker image format by @marcosrmartin in #57
• Add test step with deployed image by @ChiefGokhlayeh in #59

New Contributors

• @ChiefGokhlayeh made their first contribution in #55

Full Changelog: v5.3.0...v5.3.1

v5.3.0

What's Changed

• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #49
• Bump fedora from 37 to 38 by @dependabot in #50
• Use published image by @marcosrmartin in #53

New Contributors

• @marcosrmartin made their first contribution in #53

Full Changelog: v5.2.0...v5.3.0

v5.2.0

Replace deprecated use of ::set-output

Changelog

Added

• Note about LTeX in README

Fixed

• #48 Replaced use of ::set-output with append to $GITHUB_OUTPUTS following deprecation
• Spell-check test without dictionary now properly reports spelling mistake (as intended)
• Unreachable code in entrypoint.sh (shellcheck: SC2317)

Upgraded

• Fedora to version 37
• pre-commit
  • pre-commit-hooks to v4.4.0
  • markdownlint to v0.33.0
  • prettier to v3.0.0-alpha.5
  • shellcheck-py to v0.9.0.2
• GitHub actions
  • docker/build-push-action to v4

v5.1.0

Upgrade TeXtidote

Changelog

Important

• Switched to 3-block semantic versioning! All versions <= v4.1 follow the old 2-block system.

Added

• pre-commit.ci integration

Removed

• GitHub Workflow Code Quality (replaced by pre-commit.ci)

Upgraded

• TeXtidote to version v0.8.3
• Fedora to version 36
• pre-commit
  • pre-commit-hooks to v4.2.0
  • markdownlint to v0.31.1
  • prettier to v2.6.2
  • dockerfile_lint to v1.1.2
  • shellcheck to v0.8.0.4
• GitHub actions
  • actions/cache to v3
  • actions/checkout to v3
  • docker/setup-qemu-action to v2
  • docker/setup-buildx-action to v2
  • docker/login-action to v2
  • docker/build-push-action to v3
  • peter-evans/dockerhub-description to v3

v5.0.0

Upgrade TeXtidote

Changelog

Important

• Switched to 3-block semantic versioning! All versions <= v4.1 follow the old 2-block system.

Added

• Fedora 34 based image
• Workflow to keep rolling version tag (e.g. v5) up-to-date
• New unstable replaces previous latest image
  • latest will now point to latest stable release while unstable will follow every commit on main-branch

Removed

• Alpine Linux based image

Upgraded

• TeXtidote to version v0.8.2

v4.1

Update Readme and Improve CI/CD

Changelog

Added

• Documentation about handling false-positives
• Example for asserting (and failing the build) on lint warnings

4.0

Switch to Alpine Linux based docker image

Changelog

Added

• Alpine Linux based docker image
• Support for docker platforms linux/arm/v6 and linux/arm/v7

Improved

• Documentation and examples in README.md
• GitHub Action push-image now uses branch caching for docker image building

Removed

• Debian Linux based docker image
• Pipenv tool management for installing pre-commit (should rather be installed natively)

3.0

Provide number of warnings as Action output parameter

Changelog

Added

• GitHub Action output parameter num_warnings containing the number of warnings parsed from TeXtidote stderr output

  • Value: integer 1, 2, 10, 42, ... on successful parse, or -1 if unable to parse TeXtidote output (additionally an error is logged)

  • Example use:

    jobs:
        self-check:
            runs-on: ubuntu-latest
            steps:
                - name: Lint fine.tex
                  id: textidote
                  uses: ChiefGokhlayeh/textidote-action@v3
                  with:
                      root_file: main.tex
                - name: Assert num_warnings == 0
                  if: ${{ steps.textidote.outputs.num_warnings != 0 }}
                  run: 'echo "num_warnings: ${{ steps.textidote.outputs.num_warnings }}"; exit 1;'

Improved

• Self-checks now assert that num_warnings is properly set

Removed

• hunspell package from Docker image (not needed for TeXtidote operation?)

2.2

German Umlaute Support (and other non-English characters)

Changelog

Fixed

• TeXtidote no longer falsely reports zero warnings when checking document with umlaute (or any other non-English character)

2.1

Docker Image Documentation

Changelog

Added

• Documentation about Docker image in doc/docker/README.md
• Build Docker images for platforms: linux/386, linux/amd64, linux/arm64
  • Note: linux/arm/v6, linux/arm/v7 suffer from issues with ca-certs (see #923479) and are therefore excluded
• Automatically update Docker Hub description
• Weekly Dependabot security checks for GitHub Actions and Docker image