Merge pull request #2215 from awesome-selfhosted/cleanup-ci

cleanup/streamline/improve automated checks:

.travis.yml

@@ -2,19 +2,21 @@ language: node_js
 
 node_js:
   - "node"
+
 cache:
   npm: false
 
 before_install:
   - rvm install 2.6.2
   - gem install awesome_bot
+  - sudo apt update && sudo apt install python3-pip python3-setuptools
   - cd tests && npm install chalk && cd ..
 
 script:
-  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then git diff origin/master -U0 README.md | grep -Pos "(?<=^\+).*" >> temp.md; fi || (exit 0)'
+  - 'echo "DEBUG: $TRAVIS_BRANCH - $TRAVIS_EVENT_TYPE - $TRAVIS_PULL_REQUEST"'
-  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then node tests/test.js -r README.md -d temp.md; else node tests/test.js -r README.md; fi'
+  - 'if [ "$TRAVIS_BRANCH" == "master" ]; then make check_syntax_full; fi'
-  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then awesome_bot temp.md --allow-redirect --skip-save-results --allow 202 --white-list airsonic.github.io/docs/apps; else (exit 0); fi'
+  - 'if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_EVENT_TYPE" == "cron" ]]; then make check_all; fi'
-  - 'if [ "$TRAVIS_BRANCH" == "monthly-check" ]; then awesome_bot *.md --allow-redirect --skip-save-results --allow 202 --white-list airsonic.github.io/docs/apps; fi'
+  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then make check_pr; fi'
 
 notifications:
   email: false

Makefile

@@ -1,72 +1,52 @@
 #!/usr/bin/make -f
 SHELL = /bin/bash
-all: checks
+AWESOME_BOT_OPTIONS = --allow-redirect --skip-save-results --allow 202 --white-list airsonic.github.io/docs/apps
 
-checks: nolicenselanguage nofullstop longdescriptions syntaxerrors
+all: check_all
 
-monthly: checks awesome_bot check_github_commit_dates contrib
+# run all checks
+check_all: check_syntax_full awesome_bot check_github_commit_dates
 
-noexternallink:
+# check pull requests
-	@echo -e "\nLines with no source/demo/other link:"
+check_pr: check_syntax_diff
-	@sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '^ *\* ' | egrep --color=always '[a-z\.] `'
 
-nolicenselanguage:
+# check syntax in whole file
-	@echo -e "\nLines with only 1 or no language/license entry:"
+check_syntax_full:
-	@! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '^ *\* ' | egrep -v '` `'
+	node tests/test.js -r README.md
 
-nofullstop:
+# check syntax in the diff from master to current branch
-	@echo -e "\nLines without a full stop after description:"
+check_syntax_diff:
-	@! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '[a-z] \(\['
+	git diff origin/master -U0 README.md | grep --perl-regexp --only-matching "(?<=^\+).*" >> temp.md && \
-	@! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '[a-z] `'
+	node tests/test.js -r README.md -d temp.md && \
+	awesome_bot -f temp.md $(AWESOME_BOT_OPTIONS)
 
-longdescriptions:
+# check dead links
-	@echo -e "\nDescriptions exceeding 250 chars:"
-	@! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep --only-matching '\) - [Aa-Zz|.|\(|\)|/| |,|-]*\s\(\[' README.md | grep  '.\{257\}'
-
-syntaxerrors:
-	@echo -e "\nSyntax errors:" 
-	@! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep  '\)\(|``|\)`'
-
-#################################
-
-contrib:
-	@mv .github/.mailmap . && printf "|Commits | Author |\n| :---: | --- |\n" > AUTHORS.md && git shortlog -sne | sed -r 's/^\s*([[:digit:]]*?)\s*?(.*?)/|\1|\2|/' >> AUTHORS.md && mv .mailmap .github/.mailmap
-
-awesome_bot:
 # https://github.com/dkhamsing/awesome_bot
-	awesome_bot --allow-redirect --allow 202 -f README.md
+awesome_bot:
+	awesome_bot -f README.md $(AWESOME_BOT_OPTIONS)
 
+# check date of last commit for github.com repository URLs
 check_github_commit_dates:
+	pip3 install PyGithub
 	python3 tests/check-github-commit-dates.py
 
 #################################
 
+# update the AUTHORS.md file
+contrib:
+	@mv .github/.mailmap . && printf "|Commits | Author |\n| :---: | --- |\n" > AUTHORS.md && git shortlog -sne | sed -r 's/^\s*([[:digit:]]*?)\s*?(.*?)/|\1|\2|/' >> AUTHORS.md && mv .mailmap .github/.mailmap
 
+# add a new entry
 add:
-	@#add a new entry
+	@read -r -p "Software name: " Name && [[ ! -z "$$Name" ]] && \
-	@printf 'Software name: ' ;\
+	read -r -p "Homepage/URL: " Url && [[ ! -z "$$Url" ]] && \
-	read Name; if [ -z "$$Name" ]; then printf 'Missing software name!\n'; exit 1 ; fi ;\
+	read -r -p "Description (max 250 characters, ending with .): " Description && [[ ! -z "$$Description" ]] && \
-	printf 'Homepage URL: ' ;\
+	read -r -p "License: " License && [[ ! -z "$$License" ]] && \
-	read Url; if [ -z "$$Url" ]; then printf 'Missing main project URL!\n'; exit 1 ; fi ;\
+	read -r -p "Main server-side language/platform/requirement: " Language && [[ ! -z "$$Language" ]] && \
-	printf 'Description (max 250 characters, ending with .): ' ;\
+	read -r -p "Demo URL (optional,leave empty): " Demo && \
-	read Description; if [ -z "$$Description" ]; then printf 'Missing description!\n'; exit 1 ; fi ;\
+	if [[ "$$Demo" == "" ]]; then CDemo=""; else CDemo="[Demo]($$Demo)"; fi; \
-	printf 'License: ' ;\
+	read -r -p "Source code URL (if different from homepage): " Source && \
-	read License; if [ -z "$$License" ]; then printf 'Missing license!\n'; exit 1 ; fi ;\
+	if [[ "$$Source" == "" ]]; then CSource=""; else CSource="[Source Code]($$Source)"; fi; \
-	printf 'Main server-side language/platform/requirement: ' ;\
+	if [[ "$$CSource" == "" && "$$Demo" == "" ]]; then Moreinfo=""; else Moreinfo="($$CDemo $$CSource)"; fi; \
-	read Language; if [ -z "$$Language" ]; then printf 'Missing language!\n'; exit 1 ; fi ;\
+	echo "Copy this entry to your clipboard, paste it in the appropriate category:" ;\
-	printf 'Demo URL (if any): ' ;\
-	read Demo; if [ -z "$$Demo" ]; then CDemo="" ; else CDemo="[Demo]($$Demo)" ; fi ;\
-	printf 'Source code URL (if different from Homepage): ' ;\
-	read Source; if [ -z "$$Source" ]; then CSource="" ; else CSource="[Source Code]($$Source)" ; fi ;\
-	if [[ "$$CSource" == "" && "$$Demo" == "" ]]; \
-	then Moreinfo=""; \
-	else Moreinfo=$$(echo "($$CDemo$$CSource)" | sed 's|)\[|), [|g') ;\
-	fi ;\
-	echo -e "Copy this entry to your clipboard, paste it in the appropriate category:\n\n" ;\
 	echo "- [$$Name]($$Url) - $${Description} $${Moreinfo} \`$$License\` \`$$Language\`"
-
-
-#TODO ask for category and insert item accordingly
-#TODO check for unsorted entries
-#TODO automatically sort entries/sections
-#TODO autoupdate contributors list

README.md

@@ -1354,7 +1354,7 @@ See **[Ticketing](#ticketing)**
 - [ICEcoder](https://icecoder.net/) - ICEcoder is a web IDE / browser based code editor, which allows you to develop websites directly within the web browser. ([Demo](http://demo.icecoder.net/ICEcoder/), [Source Code](https://github.com/icecoder/ICEcoder)) `MIT` `PHP`
 - [JS Bin](http://jsbin.com/) - Open source collaborative web development debugging tool. ([Source Code](https://github.com/jsbin/jsbin)) `MIT` `Nodejs`
 - [Judge0 API](https://api.judge0.com) - Open source API to compile and run source code. ([Source Code](https://github.com/judge0/api)) `GPL-3.0` `Ruby`
-- [JupyterLab](http://jupyterlab.github.io/jupyterlab/) - Web-based environment for interactive and reproducible computing. ([Demo](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/try.jupyter.org?urlpath=lab), [Source Code](https://github.com/jupyterlab/jupyterlab/)) `BSD 3-Clause` `Python/Docker`
+- [JupyterLab](http://jupyterlab.github.io/jupyterlab/) - Web-based environment for interactive and reproducible computing. ([Demo](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/try.jupyter.org?urlpath=lab), [Source Code](https://github.com/jupyterlab/jupyterlab/)) `BSD-3-Clause` `Python/Docker`
 - [Koding](http://www.koding.com/) - The simplest way to manage your entire Dev Infrastructure. ([Source Code](https://github.com/koding/koding)) `Apache-2.0` `Nodejs`
 - [ML Workspace](https://github.com/ml-tooling/ml-workspace) - All-in-one web-based IDE for machine learning and data science. `Apache-2.0` `Docker`
 - [Regexr](http://regexr.com/) - RegExr is a HTML/JS based tool for creating, testing, and learning about Regular Expressions. ([Source Code](https://github.com/gskinner/regexr)) `MIT` `Nodejs`