zcy
/
pluto_hdl_adi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lint: Update to run only in PRs. Change version for checkout action 

* Updated action to run only in PRs on master branch, on library/ and
  projects/ paths
* Edited the text for the printed warnings
* Updated the version for the checkout action from v2 to v3

Signed-off-by: Iulia Moldovan <iulia.moldovan@analog.com>
main
Iulia Moldovan 2022-06-27 08:47:27 +01:00 committed by imoldovan
parent 171daab8f2
commit 521476a8d4
2 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.github/scripts/check_for_missing_readme_md.sh vendored
View File

@ -1,7 +1,7 @@
#!/bin/sh #!/bin/sh
# #
# Ensure there are Readme.md files in all the project directories # Ensure there are Readme.md files in all the project directories
#
set -e set -e
#set -x #set -x
@ -10,11 +10,11 @@ fail=0
check_string(){ check_string(){
needle=$1 needle=$1
if [ "$(grep "${needle}" $file | wc -l)" -eq "0" ] ; then if [ "$(grep "${needle}" $file | wc -l)" -eq "0" ] ; then
echo missing \"${needle}\" in $file echo In $file: missing \"${needle}\"
fail=1 fail=1
else else
if [ "$(grep "${needle}" $file | sed -e "s/${needle}//g" -e "s/ //g" | wc -c)" -lt "8" ] ; then if [ "$(grep "${needle}" $file | sed -e "s/${needle}//g" -e "s/ //g" | wc -c)" -lt "8" ] ; then
echo missing link for \"${needle}\" in $file echo In $file: missing link for \"${needle}\"
fail=1 fail=1
fi fi
fi fi
@ -22,7 +22,7 @@ check_string(){
MISSING=$(find projects/ -mindepth 1 -maxdepth 1 \( -path projects/common -o -path projects/scripts \) -prune -o -type d '!' -exec test -e "{}/Readme.md" ';' -print) MISSING=$(find projects/ -mindepth 1 -maxdepth 1 \( -path projects/common -o -path projects/scripts \) -prune -o -type d '!' -exec test -e "{}/Readme.md" ';' -print)
if [ "$(echo ${MISSING} | wc -c)" -gt "1" ] ; then if [ "$(echo ${MISSING} | wc -c)" -gt "1" ] ; then
echo Missing Readme.md files in the ${MISSING} echo "Missing Readme.md files in ${MISSING}"
fail=1 fail=1
fi fi
@ -34,16 +34,17 @@ do
check_string "* Project Doc" check_string "* Project Doc"
check_string "* HDL Doc" check_string "* HDL Doc"
check_string "* Linux Drivers" check_string "* Linux Drivers"
if [ "$(grep "([[:space:]]*)" $file | wc -l)" -gt "0" ] ; then if [ "$(grep "([[:space:]]*)" $file | wc -l)" -gt "0" ] ; then
echo "missing link [found ()] in $file" echo "In $file: missing link; found ()"
fail=1 fail=1
fi fi
if [ "$(grep https://wiki.analog.com/resources/tools-software/linux-drivers-all $file | wc -l)" -gt "0" ] ; then if [ "$(grep https://wiki.analog.com/resources/tools-software/linux-drivers-all $file | wc -l)" -gt "0" ] ; then
echo "Do not link to https://wiki.analog.com/resources/tools-software/linux-drivers-all in $file" echo "In $file: do not link to https://wiki.analog.com/resources/tools-software/linux-drivers-all"
fail=1 fail=1
fi fi
if [ "$(grep https://wiki.analog.com/linux $file | wc -l)" -gt "0" ] ; then if [ "$(grep https://wiki.analog.com/linux $file | wc -l)" -gt "0" ] ; then
echo "Do not link to https://wiki.analog.com/linux in $file" echo "In $file: do not link to https://wiki.analog.com/linux"
fail=1 fail=1
fi fi
done done

14
.github/workflows/test_n_lint.yml vendored
View File

@ -1,13 +1,19 @@
name: Lint name: Lint
on: [push, pull_request] on:
pull_request:
branches:
- master
paths:
- 'library/**'
- 'projects/**'
jobs: jobs:
Lint: lint:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: Check Readmes - name: Check for Readme.md
run: | run: |
bash ./.github/scripts/check_for_missing_readme_md.sh bash ./.github/scripts/check_for_missing_readme_md.sh