From 6825002c6cedf9fda6c6b1a9449e05c3df37c2ac Mon Sep 17 00:00:00 2001
From: nodiscc <nodiscc@gmail.com>
Date: Sat, 5 Sep 2020 15:39:14 +0200
Subject: [PATCH 1/2] cleanup/streamline/improve automated checks: - use a
single .travis-ci.yml for all check types (syntax on whole file, syntax on
diff/PR, full syntax + URL checks) - only check full file syntax on pushes
to master - only check diff on pushes to branches/PRs - setup a weekly cron
job on
https://travis-ci.org/github/awesome-selfhosted/awesome-selfhosted/settings
to run thee full test suite - define all tests in Makefile, let
.travis-ci.yml hanlde travis-specific logic only - rename and document
makefile targets - remove obselete.duplicate bash syntax checks - check
github last commit dates on github.com repositories during full checks -
simplify/cleanup 'make add' target
---
.travis.yml | 10 +++---
Makefile | 88 +++++++++++++++++++++--------------------------------
2 files changed, 40 insertions(+), 58 deletions(-)
diff --git a/.travis.yml b/.travis.yml
index ee19d90a..835b5f3a 100644
--- a/.travis.yml
+++ b/.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)'
- - '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_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" == "monthly-check" ]; then awesome_bot *.md --allow-redirect --skip-save-results --allow 202 --white-list airsonic.github.io/docs/apps; fi'
+ - 'echo "DEBUG: $TRAVIS_BRANCH - $TRAVIS_EVENT_TYPE - $TRAVIS_PULL_REQUEST"'
+ - 'if [ "$TRAVIS_BRANCH" == "master" ]; then make check_syntax_full; fi'
+ - 'if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_EVENT_TYPE" == "cron" ]]; then make check_all; fi'
+ - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then make check_pr; fi'
notifications:
email: false
diff --git a/Makefile b/Makefile
index f6711eb1..b5a9cb3f 100755
--- a/Makefile
+++ b/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:
- @echo -e "\nLines with no source/demo/other link:"
- @sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '^ *\* ' | egrep --color=always '[a-z\.] `'
+# check pull requests
+check_pr: check_syntax_diff
-nolicenselanguage:
- @echo -e "\nLines with only 1 or no language/license entry:"
- @! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '^ *\* ' | egrep -v '` `'
+# check syntax in whole file
+check_syntax_full:
+ node tests/test.js -r README.md
-nofullstop:
- @echo -e "\nLines without a full stop after description:"
- @! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '[a-z] \(\['
- @! sed -n -e '/BEGIN SOFTWARE LIST/,/END SOFTWARE LIST/ p' README.md | egrep '[a-z] `'
-
-longdescriptions:
- @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
+# check syntax in the diff from master to current branch
+check_syntax_diff:
+ git diff origin/master -U0 README.md | grep --perl-regexp --only-matching "(?<=^\+).*" >> temp.md && \
+ node tests/test.js -r README.md -d temp.md && \
+ awesome_bot -f temp.md $(AWESOME_BOT_OPTIONS)
+# check dead links
+# https://github.com/dkhamsing/awesome_bot
awesome_bot:
- # https://github.com/dkhamsing/awesome_bot
- awesome_bot --allow-redirect --allow 202 -f README.md
+ 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
- @printf 'Software name: ' ;\
- read Name; if [ -z "$$Name" ]; then printf 'Missing software name!\n'; exit 1 ; fi ;\
- printf 'Homepage URL: ' ;\
- read Url; if [ -z "$$Url" ]; then printf 'Missing main project URL!\n'; exit 1 ; fi ;\
- printf 'Description (max 250 characters, ending with .): ' ;\
- read Description; if [ -z "$$Description" ]; then printf 'Missing description!\n'; exit 1 ; fi ;\
- printf 'License: ' ;\
- read License; if [ -z "$$License" ]; then printf 'Missing license!\n'; exit 1 ; fi ;\
- printf 'Main server-side language/platform/requirement: ' ;\
- read Language; if [ -z "$$Language" ]; then printf 'Missing language!\n'; exit 1 ; fi ;\
- 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" ;\
+ @read -r -p "Software name: " Name && [[ ! -z "$$Name" ]] && \
+ read -r -p "Homepage/URL: " Url && [[ ! -z "$$Url" ]] && \
+ read -r -p "Description (max 250 characters, ending with .): " Description && [[ ! -z "$$Description" ]] && \
+ read -r -p "License: " License && [[ ! -z "$$License" ]] && \
+ read -r -p "Main server-side language/platform/requirement: " Language && [[ ! -z "$$Language" ]] && \
+ read -r -p "Demo URL (optional,leave empty): " Demo && \
+ if [[ "$$Demo" == "" ]]; then CDemo=""; else CDemo="[Demo]($$Demo)"; fi; \
+ read -r -p "Source code URL (if different from homepage): " Source && \
+ if [[ "$$Source" == "" ]]; then CSource=""; else CSource="[Source Code]($$Source)"; fi; \
+ if [[ "$$CSource" == "" && "$$Demo" == "" ]]; then Moreinfo=""; else Moreinfo="($$CDemo $$CSource)"; fi; \
+ echo "Copy this entry to your clipboard, paste it in the appropriate category:" ;\
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
From ae064d820b330c5c29bb2ee23aa5f55665dffe95 Mon Sep 17 00:00:00 2001
From: nodiscc <nodiscc@gmail.com>
Date: Thu, 8 Oct 2020 19:50:06 +0200
Subject: [PATCH 2/2] fix Jupyter license (no space)
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 51480e3f..fccf711c 100644
--- a/README.md
+++ b/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`