xyvs/wakapi-readme-stats
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

gitignore and makefile comments added

Browse Source
This commit is contained in:
pseusys
2023-02-11 15:30:19 +01:00
parent 9d22d51241
commit cccf1f7305
2 changed files with 23 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.gitignore vendored
View File

@@ -1,11 +1,20 @@
# Environment files:
*.env
# Generated graph images:
*.png
# Library roots:
node_modules/
venv/
# Python caches:
__pycache__/
# Package manager configuration files:
package.json
package-lock.json
# IDE configuration files:
.vscode
.idea

21
Makefile
View File

@@ -1,3 +1,4 @@
.ONESHELL:
.DEFAULT_GOAL = help
SHELL = /bin/bash
@@ -5,20 +6,23 @@ PATH := venv/bin:node_modules/.bin:$(PATH)
help:
@echo "Welcome to 'waka-readme-stats' GitHub Actions!"
@echo "The action can be tested locally with: 'make run'."
@echo "NB! For local testing Python version 3.6+ and NodeJS version between 14 and 16 are required."
@echo "The action image can be built locally with: 'make container'."
@echo "NB! For local container building Docker version 20+ is required."
@echo "The action directory and image can be cleaned with: 'make clean'."
@ # Print help commands
echo "Welcome to 'waka-readme-stats' GitHub Actions!"
echo "The action can be tested locally with: 'make run'."
echo "NB! For local testing Python version 3.6+ and NodeJS version between 14 and 16 are required."
echo "The action image can be built locally with: 'make container'."
echo "NB! For local container building Docker version 20+ is required."
echo "The action directory and image can be cleaned with: 'make clean'."
.PHONY: help
venv:
@ # Install Python virtual environment and dependencies
python3 -m venv venv
pip install --upgrade pip
pip install -r requirements.txt
node_modules:
@ # Install NodeJS dependencies
npm i npm@next-8
npm i vega vega-lite vega-cli canvas
@@ -27,19 +31,22 @@ dependencies: venv node_modules
run: dependencies
@ # Run action locally
source <(cat .env.example | sed 's/=/=/' | sed 's/^/export /') && python3 ./sources/main.py
.PHONY: run
image:
@ # Build docker image
docker build -t waka-readme-stats -f Dockerfile .
.PHONY: image
clean:
@ # Clean all build files, including: libraries, package manager configs, docker images and containers
rm -rf venv
rm -rf node_modules
rm -r package*.json
docker rmi -f waka-readme-stats 2>/dev/null || true
docker rm -f waka-readme-stats 2>/dev/null || true
docker rmi $(docker images | grep "waka-readme-stats") 2> /dev/null || true
.PHONY: clean