Skip to content

Latest commit

 

History

History

quickstart

README.md

Quickstart

This directory contains several ready-to-use workflows for a few of the more common anticipated settings. The idea is to make it as easy as possible for you to try out the action. You can start with one of these and then customize to your liking.

How to Use

To use one of these workflows, do the following:

  1. In your GitHub profile repository (repository with same name as your username), create a directory .github/workflows if you don't already have this.
  2. Pick one of the provided workflows (see the list below).
  3. Download your chosen workflow and commit it to your .github/workflows directory within your profile repository.
  4. If you didn't change the name of the file, then it will run when you push it to your repository since it has been configured to run on a push to that filename (assuming your branch is either named main or master). If you changed the name of the file, then edit the paths attribute on the push event with the new name of the workflow file.
  5. The workflow is configured to run on a schedule daily. You can change the schedule to your liking.
  6. You can also choose to run it manually because it is also configured on the workflow_dispatch event. To do this, navigate to the Actions tab for your profile repository. Select the workflow from the list of workflows on the left. You'll notice that it indicates: "This workflow has a workflow_dispatch event trigger." To the right of that click the "Run workflow" button to run the workflow manually.
  7. You'll find the SVG in the images directory (which the action creates if it doesn't already exist).
  8. Add a link to it in the README.md in your profile repository. If you used one of these workflows as is, without using the inputs to change the file name of the image, then you can add the image to your profile with the following Markdown:
![My user statistics](images/userstats.svg)

Although not required, it is appreciated if you instead link the image to this repository so that others know how you generated it, with the following markdown:

[![My user statistics](images/userstats.svg)](https://github.com/cicirello/user-statistician)

Workflow List

The ready-to-use workflows are as follows:

  • all-defaults.yml: This runs the action on a daily schedule using all of the default settings, which is a light color theme.
  • dark.yml: This runs the action on a daily schedule with a dark color theme, but otherwise uses all of the default settings.
  • dark-dimmed.yml: This runs the action on a daily schedule with a dark-dimmed color theme, but otherwise uses all of the default settings.
  • contributions.yml: This runs the action on a daily schedule, only generating the contribution stats (hiding the other sections), with a dark-dimmed theme.
  • repositories.yml: This runs the action on a daily schedule, only generating the repositories stats (hiding the other sections), with a dark-dimmed theme.
  • languages.yml: This runs the action on a daily schedule, only generating the languages distribution chart (hiding the other sections), with a dark theme.
  • multiple-stats-cards.yml: This runs the action on a daily schedule, generating three separate SVGs, one for the contribution stats, one for the repositories stats, and one for the language distribution chart. It uses the dark theme for all three. Note that if you use this one, you'll have three images to insert into your profile readme.