Skip to content

Commit

Permalink
[CTOR-179] Include orthograph/syntax checks in CI for MC documentation (
Browse files Browse the repository at this point in the history
#4788)

Co-authored-by: Sophie Depassio <[email protected]>
  • Loading branch information
lucie-dubrunfaut and sdepassio authored Feb 1, 2024
1 parent 40b0b49 commit ce2d461
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/scripts/pod_spell_check.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
use strict;
use warnings;

use Test::More;
use Test::Spelling;

if (!@ARGV) {
die "Missing perl file to check.";
}

my $stopword_filename='.github/scripts/stopwords.t';
if(defined($ARGV[1])){
$stopword_filename=$ARGV[1];
}
open(FILE, "<", $stopword_filename)
or die "Could not open $stopword_filename";
printf("stopword file use : ".$stopword_filename." \n");

add_stopwords(<FILE>);
set_spell_cmd('hunspell -l');
all_pod_files_spelling_ok($ARGV[0]);
close(FILE);
5 changes: 5 additions & 0 deletions .github/scripts/stopwords.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
--force-counters32
OID
oneaccess-sys-mib
SNMP
SSH
54 changes: 54 additions & 0 deletions .github/workflows/spellchecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: spell-checker

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

on:
workflow_dispatch:
pull_request:
paths:
- '.github/workflows/spellchecker.yml'
- 'src/**'
- '.github/scripts/pod_spell_check.t'

jobs:
pod-spell-check:
if: ${{ !contains(github.event.pull_request.labels.*.name, 'do-not-spell-check') }}
runs-on: ubuntu-22.04

steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- uses: dorny/paths-filter@4512585405083f25c027a35db413c2b3b9006d50 # v2.11.1
id: filter
with:
base: ${{ github.ref }}
list-files: shell
filters: |
plugins:
- added|modified: src/**
- name: Install CPAN Libraries
uses: shogo82148/actions-setup-perl@ea0507898383e7dbce382138da0c21af1849eb9e # v1.27.0
with:
perl-version: '5.34'
install-modules-with: cpm
install-modules: Test::More Test::Spelling

- name: Install librairies
continue-on-error: true
run: |
sudo apt-get update
sudo apt-get install -y hunspell
shell: bash

- name: Run spell check
id: run_check
run: |
set +e
for f in ${{ steps.filter.outputs.plugins_files }}; do
echo "perl .github/scripts/pod_spell_check.t $f"
output=$(perl .github/scripts/pod_spell_check.t $f)
done
shell: bash

0 comments on commit ce2d461

Please sign in to comment.