ci: Add a workflow to validate pull request titles

[shahzadlone]

Relevant issue(s)

Resolves #718

Description

A GitHub workflow action that validates PR title.

Tasks

• I made sure the code is well commented, particularly hard-to-understand areas.
• I made sure the repository-held documentation is changed accordingly.
• I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
• I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Through the CI runs of this PR.

Specify the platform(s) on which this was tested:

• WSL2 (Manjaro)

[orpheuslummis]

running the script through shellcheck gives the following advice:

Line 47:
printf "Info: label = '${LABEL}'\n";
       ^-- SC2059 (info): Don't use variables in the printf format string. Use printf '..%s..' "$foo".
 
Line 48:
printf "Info: description = '${DESCRIPTION}'\n";
       ^-- SC2059 (info): Don't use variables in the printf format string. Use printf '..%s..' "$foo".
 
Line 79:
for validLabel in ${VALID_LABELS[@]}; do
                  ^-- SC2068 (error): Double quote array expansions to avoid re-splitting elements.

https://www.shellcheck.net/

[orpheuslummis]

question: that would exclude '.' at the end right?

[shahzadlone]

Yea so a PR title with . (non-lowercase-alphabet) in the end will fail.

[fredcarle]

So this means that we want out PR titles to never have a dot at the end?

[shahzadlone]

So this means that we want out PR titles to never have a dot at the end?

That is what this action would enforce, was that not the consensus?

[shahzadlone]

running the script through shellcheck gives the following advice:

Line 47:
printf "Info: label = '${LABEL}'\n";
       ^-- SC2059 (info): Don't use variables in the printf format string. Use printf '..%s..' "$foo".
 
Line 48:
printf "Info: description = '${DESCRIPTION}'\n";
       ^-- SC2059 (info): Don't use variables in the printf format string. Use printf '..%s..' "$foo".
 
Line 79:
for validLabel in ${VALID_LABELS[@]}; do
                  ^-- SC2068 (error): Double quote array expansions to avoid re-splitting elements.

https://www.shellcheck.net/

All fixed.

[orpheuslummis]

question: that would also apply to these kinds of commits on master? if so, how could we name these merge commits? merge: xyz ?

[orpheuslummis]

question: that would also apply to these kinds of commits on master? if so, how could we name these merge commits? merge: xyz ?

answer: nope, Validate Title Workflow only applies on develop`

[fredcarle]

This is what I get when I try to run the test:

fredcarle@Freds-MBP defradb % make test:scripts
./scripts_test.sh
PASS
PASS
PASS
PASS
FAIL ...
> Command  : [./validate-conventional-style.sh 'feat: a']
> Expected : [5]
> ACTUAL   : [4]
make[1]: *** [test] Error 1

That's because readarray isn't installed by default on macOS (and probably others). See my suggestion bellow.

[fredcarle]

So this means that we want out PR titles to never have a dot at the end?

[shahzadlone]

That's because readarray isn't installed by default on macOS (and probably others). See my suggestion bellow.

Solved using sed, LMK if it works for macOS now.

[fredcarle]

LGTM!