├── .github ├── dependabot.yml └── workflows │ ├── gitartwork.yml │ └── dependabotautomerge.yml ├── action.yml ├── package.json ├── LICENSE.md ├── README.md └── gitartwork.svg /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: / 5 | schedule: 6 | interval: monthly 7 | 8 | - package-ecosystem: npm 9 | directory: / 10 | schedule: 11 | interval: monthly -------------------------------------------------------------------------------- /.github/workflows/gitartwork.yml: -------------------------------------------------------------------------------- 1 | name: gitartwork from a contribution graph 2 | on: 3 | workflow_dispatch: 4 | jobs: 5 | build: 6 | name: Make gitartwork SVG 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v3 10 | - uses: jasineri/gitartwork@v1 11 | with: 12 | user_name: jasineri 13 | text: JASINERI 14 | - uses: jasineri/simple-push-action@v1 15 | -------------------------------------------------------------------------------- /.github/workflows/dependabotautomerge.yml: -------------------------------------------------------------------------------- 1 | name: "Dependabot Automerge - Action" 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | Merge_pull_request: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v3 12 | 13 | - name: Approve pull request by GitHub-Actions bot 14 | uses: actions/github-script@v6 15 | with: 16 | github-token: ${{secrets.GITHUB_TOKEN}} 17 | script: | 18 | github.pulls.createReview({ 19 | event: "APPROVE" 20 | }); -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: gitartwork on contribution graph 2 | description: gitartwork on users contribution graph 3 | author: jasineri 4 | inputs: 5 | user_name: 6 | description: Username 7 | default: jasineri 8 | required: true 9 | text: 10 | description: Text on contribution graph 11 | default: JASINERI 12 | required: true 13 | svg_file_name: 14 | description: 'SVG file name (optional), default: gitartwork.svg' 15 | default: gitartwork.svg 16 | required: false 17 | runs: 18 | using: node16 19 | main: dist/index.js 20 | branding: 21 | icon: aperture 22 | color: blue 23 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitartwork", 3 | "version": "1.0.0", 4 | "description": "
", 5 | "main": "dist/index.js", 6 | "scripts": { 7 | "prestart" : "npm run format && npm run build", 8 | "start": "( node dist/index.js )", 9 | "build": "tsc && ncc -m build lib/main.js", 10 | "format": "prettier --write **/*.ts" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "git+https://github.com/jasineri/gitartwork.git" 15 | }, 16 | "keywords": [], 17 | "author": "jasineri", 18 | "license": "ISC", 19 | "bugs": { 20 | "url": "https://github.com/jasineri/gitartwork/issues" 21 | }, 22 | "homepage": "https://github.com/jasineri/gitartwork#readme", 23 | "dependencies": { 24 | "@actions/core": "^1.10.0", 25 | "@actions/github": "^5.1.1" 26 | }, 27 | "devDependencies": { 28 | "@types/node": "^18.14.2", 29 | "@vercel/ncc": "^0.36.1", 30 | "node-html-parser": "^6.1.13", 31 | "prettier": "^2.8.4", 32 | "typescript": "^4.9.5" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Copyright (c) 2022, Nerijus Jasinskas 2 | 3 | All rights reserved. 4 | 5 | Redistribution and use in source and binary forms, with or without 6 | modification, are permitted provided that the following conditions are met: 7 | 8 | * Redistributions of source code must retain the above copyright notice, this 9 | list of conditions and the following disclaimer. 10 | 11 | * Redistributions in binary form must reproduce the above copyright notice, 12 | this list of conditions and the following disclaimer in the documentation 13 | and/or other materials provided with the distribution. 14 | 15 | * Neither the name of the copyright holder nor the names of its 16 | contributors may be used to endorse or promote products derived from 17 | this software without specific prior written permission. 18 | 19 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 23 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 25 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 26 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 27 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gitartwork on user's contribution graph 2 | 3 | gitartwork on user's contribution graph, make a SVG image of it and finally push it back to your repository. 4 | 5 | An example result: 6 | [](https://github.com/jasineri/gitartwork) 7 | 8 | ## Usage: 9 | 10 | ### Option #1: Use gitartwork as a GitHub Action 11 | 1. Ensure that under Settings > Actions > General > Workflow permissions, the "Read and write permissions" is set! 12 | 2. Copy the workflow code into a `.github/workflows/gitartwork.yml` file in your repository. 13 | 14 | name: gitartwork from a contribution graph 15 | on: 16 | push: 17 | jobs: 18 | build: 19 | name: Make gitartwork SVG 20 | runs-on: ubuntu-latest 21 | steps: 22 | - uses: actions/checkout@v3 23 | - uses: jasineri/gitartwork@v1 24 | with: 25 | # Use this username's contribution graph 26 | user_name: jasineri 27 | # Text on contribution graph 28 | text: JASINERI 29 | - uses: jasineri/simple-push-action@v1 30 | 31 | 2. A few moments later it will generate `gitartwork.svg` image in your repository, so then you can include it in your `README.md` like `` 32 | 3. Have fun :) 33 | 34 | ## Troubleshooting 35 | 1. If your gitartwork's image is missing and the action workflow ends with an error message stating "Permission to ... denied to github-actions\[bot\]", check the workflow permissions settings (see "Usage" above). 36 | 37 | ### Option #2: Make gitartwork locally on your environment 38 | Still in progress... 39 | -------------------------------------------------------------------------------- /gitartwork.svg: -------------------------------------------------------------------------------- 1 | 2176 | --------------------------------------------------------------------------------