From 99f77feb8f2f0b2e1bce9fd16811f49ea445ab2f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 12 Feb 2024 18:01:42 +0000 Subject: [PATCH 1/7] Bump python from 3.12.1-slim-bullseye to 3.12.2-slim-bullseye Bumps python from 3.12.1-slim-bullseye to 3.12.2-slim-bullseye. --- updated-dependencies: - dependency-name: python dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 02d8d42d..a72b77e0 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ # REF: https://hub.docker.com/_/python -FROM python:3.12.1-slim-bullseye +FROM python:3.12.2-slim-bullseye LABEL "com.github.actions.name"="Spellcheck Action" LABEL "com.github.actions.description"="Check spelling of files in repository" From 693ff741bf556d8b357974ea17f0734f626690a2 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 15 Apr 2024 18:05:21 +0000 Subject: [PATCH 2/7] Bump python from 3.12.2-slim-bullseye to 3.12.3-slim-bullseye Bumps python from 3.12.2-slim-bullseye to 3.12.3-slim-bullseye. --- updated-dependencies: - dependency-name: python dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index a72b77e0..94dc633e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ # REF: https://hub.docker.com/_/python -FROM python:3.12.2-slim-bullseye +FROM python:3.12.3-slim-bullseye LABEL "com.github.actions.name"="Spellcheck Action" LABEL "com.github.actions.description"="Check spelling of files in repository" From e36f662b21ead3f6f29794ac5c35069bf236463c Mon Sep 17 00:00:00 2001 From: jonasbn Date: Sat, 1 Jun 2024 17:51:58 +0200 Subject: [PATCH 3/7] Preparing release 0.37.0 --- CHANGELOG.md | 8 +++++++- README.md | 15 ++++++++------- action.yml | 2 +- 3 files changed, 16 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eef9e273..07bb3fd0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,16 @@ # Change Log for spellcheck-github-actions +## 0.37.0, 2024-01-01, maintenance release, update not required + +- Docker image updated to Python 3.12.3 slim via PR [#199](https://github.com/rojopolis/spellcheck-github-actions/pull/199) from Dependabot. [Release notes for Python 3.12.3](https://docs.python.org/release/3.12.3/whatsnew/changelog.html) + +- Docker image updated to Python 3.12.2 slim via PR [#197](https://github.com/rojopolis/spellcheck-github-actions/pull/197) from Dependabot. [Release notes for Python 3.12.2](https://docs.python.org/release/3.12.2/whatsnew/changelog.html) + ## 0.36.0, 2024-02-06, feature release, update not required - With version 2.10 of **PySpelling** the action now supports the configuration of running jobs in parallel, see the [documentation for PySpelling](https://facelessuser.github.io/pyspelling/configuration/) -- Docker image updated to Python 3.12.1 slim via PR [#177](https://github.com/rojopolis/spellcheck-github-actions/pull/191) from Dependabot. [Release notes for Python 3.12.1](https://docs.python.org/release/3.12.1/whatsnew/changelog.html) +- Docker image updated to Python 3.12.1 slim via PR [#191](https://github.com/rojopolis/spellcheck-github-actions/pull/191) from Dependabot. [Release notes for Python 3.12.1](https://docs.python.org/release/3.12.1/whatsnew/changelog.html) ## 0.35.0, 2023-11-16, maintenance release, update not required diff --git a/README.md b/README.md index 585d7147..dbbaff8b 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ This action uses [PySpelling][pyspelling] to check spelling in source files in t - [Extra Configuration for Markdown](#extra-configuration-for-markdown) - [Spellcheck Configuration File](#spellcheck-configuration-file) - [Predefined Name](#predefined-name) +- [Specifying Number of Jobs for Parallel Processing](#specifying-number-of-jobs-for-parallel-processing) - [Specifying Language](#specifying-language) - [Checking For Bad Spelling](#checking-for-bad-spelling) - [Language Support](#language-support) @@ -103,7 +104,7 @@ jobs: steps: # The checkout step - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.36.0 + - uses: rojopolis/spellcheck-github-actions@0.37.0 name: Spellcheck ``` @@ -113,7 +114,7 @@ For example, it could be named `.github/workflows/spelling_action.yml` for easy ### Using a Canonical Version -In the above example, the configuration is pointing to the exact version of `0.36.0`, this repository also offers the canonical version `v0`, so there is less hassle keeping the action up to date. +In the above example, the configuration is pointing to the exact version of `0.37.0`, this repository also offers the canonical version `v0`, so there is less hassle keeping the action up to date. ```yaml name: Spellcheck Action @@ -201,7 +202,7 @@ jobs: steps: # The checkout step - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.36.0 + - uses: rojopolis/spellcheck-github-actions@0.37.0 name: Spellcheck with: source_files: README.md CHANGELOG.md notes/Notes.md @@ -229,7 +230,7 @@ jobs: steps: # The checkout step - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.36.0 + - uses: rojopolis/spellcheck-github-actions@0.37.0 name: Spellcheck with: source_files: README.md CHANGELOG.md notes/Notes.md @@ -316,7 +317,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.36.0 + - uses: rojopolis/spellcheck-github-actions@0.37.0 name: Spellcheck with: config_path: config/.spellcheck.yml # put path to configuration file here @@ -516,7 +517,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.36.0 + - uses: rojopolis/spellcheck-github-actions@0.37.0 name: Spellcheck with: config_path: .github/spellcheck.yml # <--- put path to configuration file here @@ -731,7 +732,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.36.0 + - uses: rojopolis/spellcheck-github-actions@0.37.0 name: Spellcheck ``` diff --git a/action.yml b/action.yml index 540777dd..35333da7 100644 --- a/action.yml +++ b/action.yml @@ -23,4 +23,4 @@ branding: icon: type runs: using: docker - image: 'docker://jonasbn/github-action-spellcheck:0.36.0' + image: 'docker://jonasbn/github-action-spellcheck:0.37.0' From 303ac2391cf97de3d82da29460b9f8cff9fb6cf7 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Wed, 5 Jun 2024 20:31:52 +0200 Subject: [PATCH 4/7] Added helper tool for making releases --- .perlcriticrc | 13 ++++++++++ scripts/build.pl | 62 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 .perlcriticrc create mode 100755 scripts/build.pl diff --git a/.perlcriticrc b/.perlcriticrc new file mode 100644 index 00000000..02a0a572 --- /dev/null +++ b/.perlcriticrc @@ -0,0 +1,13 @@ +[InputOutput::RequireCheckedSyscalls] +functions = :builtins +exclude_functions = print say + +[-Modules::RequireVersionVar] + +[CodeLayout::RequireTidyCode] + +[-Miscellanea::ProhibitUselessNoCritic] + +[-ValuesAndExpressions::ProhibitVersionStrings] + +[-ErrorHandling::RequireCarping] diff --git a/scripts/build.pl b/scripts/build.pl new file mode 100755 index 00000000..7ce3a531 --- /dev/null +++ b/scripts/build.pl @@ -0,0 +1,62 @@ +#!/usr/bin/env perl + +use warnings; +use strict; +use v5.10.0; + +my $version = $ARGV[0]; + +if (not $version) { + die 'Usage build.pl '; +} + +say "Building Docker images for version: $version"; + +my @targets = qw(v0 latest); + +push @targets, $version; + +say 'Building Docker images for amd64 architecture'; + +my $counter = 0; +my $total = scalar @targets; + +foreach my $target (@targets) { + say "Building $target ($counter/$total)"; + system "docker build --platform linux/amd64 --tag jonasbn/github-action-spellcheck:$target ."; + $counter++; +} + +$counter = 0; + +say "Pushing Docker images to DockerHub"; +foreach my $target (@targets) { + say "Pushing $target ($counter/$total)"; + system "docker push jonasbn/github-action-spellcheck:$target"; + $counter++; +} + +# Updating the v0 tag +say 'Deleting existing tag v0 locally'; +say 'git tag --delete v0'; +system 'git tag --delete v0'; + +say 'Deleting existing tag v0 remotely'; +say 'git push --delete origin v0'; +system 'git push --delete origin v0'; + +say 'Tagging also as v0'; +say 'git tag --annotate v0 --message "Tagging v0"'; +system 'git tag --annotate v0 --message "Tagging v0"'; + +# Pushing tags +say 'Pushing tags'; +say 'git push --tags'; +system 'git push --tags'; + +# The tagging of the version number is a part of the release process, so not need +# to tag create this tag separately +say 'Creating release on GitHub with auto generated release notes and discussion'; +system "gh release create $version --discussion-category 'General' --generate-notes"; + +exit 0; From 681762f8b44e9508e96772da07c8469d77142211 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Thu, 6 Jun 2024 07:05:27 +0200 Subject: [PATCH 5/7] Minor annotation to the code --- scripts/build.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/build.pl b/scripts/build.pl index 7ce3a531..e401ba50 100755 --- a/scripts/build.pl +++ b/scripts/build.pl @@ -54,8 +54,8 @@ say 'git push --tags'; system 'git push --tags'; -# The tagging of the version number is a part of the release process, so not need -# to tag create this tag separately +# The tagging of the version number is a part of the release process, so not need +# to create this tag separately say 'Creating release on GitHub with auto generated release notes and discussion'; system "gh release create $version --discussion-category 'General' --generate-notes"; From a308a47b0488ec07a8d1e26824af789209b3c9c4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Jun 2024 18:34:08 +0000 Subject: [PATCH 6/7] Bump python from 3.12.3-slim-bullseye to 3.12.4-slim-bullseye Bumps python from 3.12.3-slim-bullseye to 3.12.4-slim-bullseye. --- updated-dependencies: - dependency-name: python dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 94dc633e..f0b7e2d1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ # REF: https://hub.docker.com/_/python -FROM python:3.12.3-slim-bullseye +FROM python:3.12.4-slim-bullseye LABEL "com.github.actions.name"="Spellcheck Action" LABEL "com.github.actions.description"="Check spelling of files in repository" From d354a4dc525c8067555c7481b60416cedb0060ff Mon Sep 17 00:00:00 2001 From: jonasbn Date: Thu, 13 Jun 2024 17:49:37 +0200 Subject: [PATCH 7/7] Preparing release 0.38.0 --- CHANGELOG.md | 6 +++++- README.md | 14 +++++++------- action.yml | 2 +- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 07bb3fd0..eb72816f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,10 @@ # Change Log for spellcheck-github-actions -## 0.37.0, 2024-01-01, maintenance release, update not required +## 0.38.0, 2024-06-13, maintenance release, update not required + +- Docker image updated to Python 3.12.4 slim via PR [#202](https://github.com/rojopolis/spellcheck-github-actions/pull/202) from Dependabot. [Release notes for Python 3.12.4](https://docs.python.org/release/3.12.4/whatsnew/changelog.html) + +## 0.37.0, 2024-06-01, maintenance release, update not required - Docker image updated to Python 3.12.3 slim via PR [#199](https://github.com/rojopolis/spellcheck-github-actions/pull/199) from Dependabot. [Release notes for Python 3.12.3](https://docs.python.org/release/3.12.3/whatsnew/changelog.html) diff --git a/README.md b/README.md index dbbaff8b..064d64f7 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ jobs: steps: # The checkout step - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.37.0 + - uses: rojopolis/spellcheck-github-actions@0.38.0 name: Spellcheck ``` @@ -114,7 +114,7 @@ For example, it could be named `.github/workflows/spelling_action.yml` for easy ### Using a Canonical Version -In the above example, the configuration is pointing to the exact version of `0.37.0`, this repository also offers the canonical version `v0`, so there is less hassle keeping the action up to date. +In the above example, the configuration is pointing to the exact version of `0.38.0`, this repository also offers the canonical version `v0`, so there is less hassle keeping the action up to date. ```yaml name: Spellcheck Action @@ -202,7 +202,7 @@ jobs: steps: # The checkout step - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.37.0 + - uses: rojopolis/spellcheck-github-actions@0.38.0 name: Spellcheck with: source_files: README.md CHANGELOG.md notes/Notes.md @@ -230,7 +230,7 @@ jobs: steps: # The checkout step - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.37.0 + - uses: rojopolis/spellcheck-github-actions@0.38.0 name: Spellcheck with: source_files: README.md CHANGELOG.md notes/Notes.md @@ -317,7 +317,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.37.0 + - uses: rojopolis/spellcheck-github-actions@0.38.0 name: Spellcheck with: config_path: config/.spellcheck.yml # put path to configuration file here @@ -517,7 +517,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.37.0 + - uses: rojopolis/spellcheck-github-actions@0.38.0 name: Spellcheck with: config_path: .github/spellcheck.yml # <--- put path to configuration file here @@ -732,7 +732,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - uses: rojopolis/spellcheck-github-actions@0.37.0 + - uses: rojopolis/spellcheck-github-actions@0.38.0 name: Spellcheck ``` diff --git a/action.yml b/action.yml index 35333da7..5357aa36 100644 --- a/action.yml +++ b/action.yml @@ -23,4 +23,4 @@ branding: icon: type runs: using: docker - image: 'docker://jonasbn/github-action-spellcheck:0.37.0' + image: 'docker://jonasbn/github-action-spellcheck:0.38.0'