Copy Repository

1. Click the link to: Create your own copy of this repository for viewing your GitHub stats

   • Note: the first GitHub Actions workflow initiated at creation of the copied repository is expected to fail

Generate a New Personal Access Token

2. Generate a personal access token by following these steps:
   1. If you are logged in, click this link to: generate a new token
      • Otherwise, to learn how to generate a personal access token: read these instructions
   2. Name the token
   3. Select your preferred 'Expiration' date
   4. Select repo for 'Full control of private repositories'
   5. Select read:user to 'Read ALL user profile data'
   6. Click the 'Generate token' button
   7. Copy the generated token - there is only one opportunity provided for this

Create ACCESS_TOKEN Secret

3. Create a repository secret for the personal access token by following these steps:
   1. If this is your copy of the repository, click this link to: create a new secret
      • Otherwise, go to repository Settings, click the Secrets option, then click New repository secret
   2. Name the new secret: ACCESS_TOKEN
   3. Enter the generated personal access token as the 'Value'

Run GitHub Actions Workflow

4. Manually generate GitHub statistics visualizations:
   1. This can be done using any of the following two GitHub Actions workflows:
      1. For the first time, or to reset stored statistics (although this is done with every push to master):
         • Click the link to: go to the Generate Git Stats Images GitHub Actions workflow

         This is required if the actions_branch branch is not created, as it is created when run

      2. Otherwise, for updating generated statistics visualizations (although this is automatically done daily):
         • Click the link to: go to the Auto Update Stats Images GitHub Actions workflow

         This requires the actions_branch branch to first be created with generated statistics visualizations

   2. With the GitHub Actions page open, click the 'Run workflow' dropdown menu button
   3. Select Branch: master from the 'Use workflow from' dropdown list
   4. Click the 'Run workflow' button

View Generated Statistics

5. Following the successful completion of a workflow, generated statistics visualizations can be viewed:
   1. In the generated_images directory in the actions_branch branch with the following image links:
      1. Language statistics using @media prefers-color-scheme for dark and light mode - not tested
      2. Language statistics in light mode only
      3. Language statistics in dark mode only
      4. Overview statistics using @media prefers-color-scheme for dark and light mode - not tested
      5. Overview statistics in light mode only
      6. Overview statistics in dark mode only

Display Generated Statistics

6. To display the generated statistics, constant URLs can be used for images that are updated daily:
   1. For a GitHub profile README.md, attach #gh-light-mode-only and #gh-dark-mode-only to light and dark raw image links, respectively, such as:
      1. For generated language statistics visualizations (replacing with your GitHub username):

      ![](https://raw.githubusercontent.com/
              /GitStats/actions_branch/generated_images/languagesLightMode.svg
              #gh-light-mode-only)![](https://raw.githubusercontent.com/
              
               /GitStats/actions_branch/generated_images/languagesDarkMode.svg
               #gh-dark-mode-only)
              
             

      2. For generated overview statistic visualizations (replacing with your GitHub username):

      ![](https://raw.githubusercontent.com/
              /GitStats/actions_branch/generated_images/overviewLightMode.svg
              #gh-light-mode-only)![](https://raw.githubusercontent.com/
              
               /GitStats/actions_branch/generated_images/overviewDarkMode.svg
               #gh-dark-mode-only)
              
             

   2. For websites, use the raw image URLs for any suitable image from the above View Generated Statistics links.

      Note: I have not used the images on any website other than the following GitHub pages:

      https://r055a.github.io/profile/statistics/

      https://r055a.github.io/university-projects/statistics/

• Secret Name: EXCLUDED
  • for excluding listed repositories from being included in the generated statistic visualizations
  • enter Value in the following format (separated by commas):
    • [owner/repo],[owner/repo],...,[owner/repo]
  • example:
    • jstrieb/github-stats,rahul-jha98/github-stats-transparent,idiotWu/stats
• Secret Name: ONLY_INCLUDED
  • for ONLY including listed repositories in the generated statistic visualizations
  • enter Value in the following format (separated by commas):
    • [owner/repo],[owner/repo],...,[owner/repo]
  • example:
    • R055A/GitStats,R055A/R055A
• Secret Name EXCLUDED_LANGS
  • for excluding listed languages from being included in the generated statistic visualizations
  • enter Value in the following format (separated by commas):
    • [language],[language],...,[language]
  • example:
    • HTML,Jupyter Notebook,Makefile,Dockerfile
• Secret Name INCLUDE_FORKED_REPOS
  • for including forked repositories in the generated statistic visualizations
    • false by default
  • enter Value in the following format:
  • examples:
    • true
• Secret Name EXCLUDE_CONTRIB_REPOS
  • for excluding repositories (pull request) contributed to in the generated statistic visualizations
    • false by default
  • enter Value in the following format:
  • examples:
    • true
• Secret Name EXCLUDE_ARCHIVE_REPOS
  • for excluding archived repositories in the generated statistic visualizations
    • false by default
  • enter Value in the following format:
  • examples:
    • true
• Secret Name EXCLUDE_PRIVATE_REPOS
  • for excluding private repositories in the generated statistic visualizations
    • false by default
  • enter Value in the following format:
  • examples:
    • true
• Secret Name EXCLUDE_PUBLIC_REPOS
  • for excluding public repositories in the generated statistic visualizations
    • false by default
  • enter Value in the following format:
  • examples:
    • true
• Secret Name MORE_REPOS
  • for including repositories that are otherwise not included in the generated statistic visualizations
    • such as imported repositories with contributions
  • enter Value in the following format (separated by commas):
    • [owner/repo],[owner/repo],...,[owner/repo]
  • example:
    • R055A/GitStats,R055A/R055A
• Secret Name MORE_COLLABS
  • for adding a constant value to the generated repository collaborators statistic
    • such as for collaborators that are otherwise not represented
  • enter Value in the following format:
  • example:
    • 4
• Secret Name STORE_REPO_CLONES
  • for storing generated repository clone statistic visualization data beyond the 14 day-limit GitHub API allows
    • true by default
  • enter Value in the following format:
  • examples:
    • false
• Secret Name STORE_REPO_VIEWS
  • for storing generated repository view statistic visualization data beyond the 14 day-limit GitHub API allows
    • true by default
  • enter Value in the following format:
  • examples:
    • false
• Secret Name REPO_VIEWS
  • for adding a constant value to the generated repository view statistics
    • such as for when the stored data is reset or when importing stat data from elsewhere
    • requires being removed within 14 days after the first workflow is run (with LAST_VIEWED)
    • requires corresponding LAST_VIEWED and FIRST_VIEWED Secrets
  • enter Value in the following format:
  • example:
    • 5000
• Secret Name LAST_VIEWED
  • for updating the date the generated repository view statistics data is added to storage from
    • such as for when the stored data is reset or when importing stat data from elsewhere
    • requires being removed within 14 days after the first workflow is run (with REPO_VIEWS)
    • may require corresponding REPO_VIEWS and FIRST_VIEWED Secrets
  • enter Value in the following format:
    • YYYY-MM-DD
  • example:
    • 2020-10-01
• Secret Name FIRST_VIEWED
  • for updating the 'as of' date the generated repository view statistics data is stored from
    • such as for when the stored data is reset or when importing stat data from elsewhere
    • may require corresponding REPO_VIEWS and LAST_VIEWED Secrets
  • enter Value in the following format:
    • YYYY-MM-DD
  • example:
    • 2021-03-31
• Secret Name REPO_CLONES
  • for adding a constant value to the generated repository clone statistics
    • such as for when the stored data is reset or when importing stat data from elsewhere
    • requires being removed within 14 days after the first workflow is run (with LAST_CLONED)
    • requires corresponding LAST_CLONED and FIRST_CLONED Secrets
  • enter Value in the following format:
  • example:
    • 2500
• Secret Name LAST_CLONED
  • for updating the date the generated repository clone statistics data is added to storage from
    • such as for when the stored data is reset or when importing stat data from elsewhere
    • requires being removed within 14 days after the first workflow is run (with REPO_CLONES)
    • may require corresponding REPO_CLONES and FIRST_CLONED Secrets
  • enter Value in the following format:
    • YYYY-MM-DD
  • example:
    • 2020-10-01
• Secret Name FIRST_CLONED
  • for updating the 'as of' date the generated repository clone statistics data is stored from
    • such as for when the stored data is reset or when importing stat data from elsewhere
    • may require corresponding REPO_CLONES and LAST_CLONED Secrets
  • enter Value in the following format:
    • YYYY-MM-DD
  • example:
    • 2021-04-01