Merge pull request #352 from anmol098/feat/image_building_and_publishing

Feature: image building and publishing

.env.example

@@ -1,22 +1,22 @@
-INPUT_WAKATIME_API_KEY=""
-INPUT_PUSH_BRANCH_NAME="main"
-INPUT_SECTION_NAME="waka"
-INPUT_SHOW_TIMEZONE="True"
-INPUT_SHOW_PROJECTS="False"
-INPUT_SHOW_EDITORS="False"
-INPUT_SHOW_OS="False"
-INPUT_SHOW_LANGUAGE="False"
-INPUT_GH_TOKEN=""
-INPUT_SYMBOL_VERSION="1"
-INPUT_SHOW_LINES_OF_CODE="False"
-INPUT_SHOW_LOC_CHART="False"
-INPUT_SHOW_PROFILE_VIEWS="False"
-INPUT_SHOW_TOTAL_CODE_TIME="True"
-INPUT_SHOW_SHORT_INFO="False"
-INPUT_SHOW_COMMIT="False"
-INPUT_SHOW_DAYS_OF_WEEK="True"
-INPUT_SHOW_LANGUAGE_PER_REPO="True"
-INPUT_SHOW_UPDATED_DATE="True"
-INPUT_UPDATED_DATE_FORMAT="%d/%m/%Y %H:%M:%S"
-INPUT_COMMIT_BY_ME="False"
-INPUT_COMMIT_MESSAGE="Updated with Dev Metrics"
+INPUT_WAKATIME_API_KEY=YOUR_WAKATIME_API_KEY
+INPUT_PUSH_BRANCH_NAME=main
+INPUT_SECTION_NAME=waka
+INPUT_SHOW_TIMEZONE=True
+INPUT_SHOW_PROJECTS=True
+INPUT_SHOW_EDITORS=True
+INPUT_SHOW_OS=True
+INPUT_SHOW_LANGUAGE=True
+INPUT_GH_TOKEN=YOUR_GITHUB_TOKEN_KEY
+INPUT_SYMBOL_VERSION=1
+INPUT_SHOW_LINES_OF_CODE=True
+INPUT_SHOW_LOC_CHART=True
+INPUT_SHOW_PROFILE_VIEWS=True
+INPUT_SHOW_TOTAL_CODE_TIME=True
+INPUT_SHOW_SHORT_INFO=True
+INPUT_SHOW_COMMIT=True
+INPUT_SHOW_DAYS_OF_WEEK=True
+INPUT_SHOW_LANGUAGE_PER_REPO=True
+INPUT_SHOW_UPDATED_DATE=True
+INPUT_UPDATED_DATE_FORMAT=%d/%m/%Y %H:%M:%S
+INPUT_COMMIT_BY_ME=False
+INPUT_COMMIT_MESSAGE=Updated with Dev Metrics

.github/workflows/build_image.yml

@@ -0,0 +1,37 @@
+name: PUBLISH_IMAGE
+
+on:
+  push:
+
+jobs:
+  publish-server-image:
+    name: Publish 'waka-readme-stats' image
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+
+      - name: Log in to the container registry 🚪
+        uses: docker/login-action@v2
+        with:
+          username: wakareadmestats
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker 🏋️
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: waka-readme-stats
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      - name: Build and push Docker image 🏗️
+        uses: docker/build-push-action@v3
+        with:
+          push: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/releases') }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -1,6 +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

Dockerfile

@@ -1,18 +1,14 @@
 FROM nikolaik/python-nodejs:python3.9-nodejs16
 
-ADD requirements.txt /requirements.txt
-ADD main.py /main.py
-ADD loc.py /loc.py
-ADD make_bar_graph.py /make_bar_graph.py
-ADD colors.json /colors.json
-ADD translation.json /translation.json
+ENV PYTHONUNBUFFERED 1
+ENV PYTHONDONTWRITEBYTECODE 1
 
-ENV PATH "$PATH:/home/root/.npm-global/bin"
+WORKDIR /waka-readme-stats
 
-RUN python -m pip install --upgrade pip wheel setuptools
-RUN pip install -r requirements.txt
-RUN npm -g config set user root
-RUN npm i -g npm@next-8
-RUN npm i -g vega vega-lite vega-cli canvas
+ADD requirements.txt ./requirements.txt
+RUN pip install --upgrade pip && pip install -r requirements.txt
+RUN npm i npm@next-8 && npm i vega vega-lite vega-cli canvas
 
-ENTRYPOINT ["python", "/main.py"]
+ADD sources/* ./
+
+ENTRYPOINT python3 ./main.py

Makefile

@@ -0,0 +1,49 @@
+.ONESHELL:
+.DEFAULT_GOAL = help
+SHELL = /bin/bash
+
+PATH := venv/bin:node_modules/.bin:$(PATH)
+
+
+help:
+	@ # 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
+
+
+run-locally: venv node_modules
+	@ # Run action locally
+	source <(cat .env.example | sed 's/=/=/' | sed 's/^/export /') && python3 ./sources/main.py
+.PHONY: run-locally
+
+run-container:
+	@ # Run action in container
+	docker build -t waka-readme-stats -f Dockerfile .
+	docker run --env-file .env.example waka-readme-stats
+.PHONY: run-container
+
+
+clean:
+	@ # Clean all build files, including: libraries, package manager configs, docker images and containers
+	rm -rf venv
+	rm -rf node_modules
+	rm -f package*.json
+	docker rm -f waka-readme-stats 2>/dev/null || true
+	docker rmi $(docker images | grep "waka-readme-stats") 2> /dev/null || true
+.PHONY: clean

action.yml

@@ -134,7 +134,7 @@ inputs:
 
 runs:
   using: 'docker'
-  image: 'Dockerfile'
+  image: 'waka-readme-stats:master'
 
 branding:
   icon: 'activity'

requirements.txt

@@ -1,35 +1,9 @@
-altair==4.1.0
-altair-data-server==0.4.1
-altair-saver==0.5.0
-altair-viewer==0.3.0
-attrs==20.3.0
-certifi==2020.12.5
-chardet==4.0.0
-cycler==0.10.0
-Deprecated==1.2.12
-entrypoints==0.3
-humanize==3.3.0
-idna==2.10
-Jinja2==2.11.3
-jsonschema==3.2.0
-kiwisolver==1.3.1
-MarkupSafe==1.1.1
-matplotlib==3.4.1
-numpy==1.20.2
-pandas==1.2.3
-Pillow==8.2.0
-portpicker==1.3.1
 PyGithub==1.54.1
-PyJWT==1.7.1
-pyparsing==2.4.7
-pyrsistent==0.17.3
-python-dateutil==2.8.1
+matplotlib==3.4.1
 python-dotenv==0.17.0
+numpy==1.24.1
+pandas==1.2.3
+altair==4.1.0
+altair-saver==0.5.0
 pytz==2021.1
-requests==2.25.1
-selenium==3.141.0
-six==1.15.0
-toolz==0.11.1
-tornado==6.1
-urllib3==1.26.5
-wrapt==1.12.1
+humanize==3.3.0