metrics

📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON!

MIT License

Stars
12.6K
Committers
60

Bot releases are hidden (Show)

metrics - Version 3.3

Published by lowlighter over 3 years ago

📦 New features

  • 🌸 Anilist plugin
    • #69 Display your favorite manga, anime and characters along with your watching list and activity from AniList
  • 🈷️ Languages plugin
    • #72 Add new option plugin_languages_colors to use custom languages colors
      • #76 #77 Use predefined sets of colors
      • #87 Add plugin_languages_details to display additional details like total bytes sizes and percentages
  • 🎧 Music plugin
    • #73 Add new provider lastfm to display recently listed tracks from Last.fm
    • #73 Add new option plugin_music_user to select music plugin target user (defaults to GitHub username)
  • 🎫 Gists plugin
    • #74 Plugin can now support users with more than 100 gists
  • 🗂️ Projects plugin
    • #75 Add new option plugin_projects_descriptions to display project's descriptions
  • 🧑‍🤝‍🧑 People plugin
    • #78 Add support for repository template
    • #78 plugin_people_types now affects ordering of displayed sections
    • #78 plugin_people_types now support sponsors and sponsoring for users and contributors, stargazers, watchers and sponsors for repositories
    • #78 Add support for plugin_people
  • 🌇 Organizations accounts
    • #81 Metrics is now compatible with organization account !
      • Most of plugins are compatible except a few one (see Compatibility Matrix for more informations)
      • You'll need to add read:org scope to your personal token (see documentation for more details)
    • #80 Add support for repository template owned by an organization account
  • 🦑 Miscelleanous
    • #68 Add new option setup_community_templates to use templates from forks
    • #82 Refactor most of the code with a lot meta-programming
      • Most parts are now auto-loaded dynamically so there's no need to patch multiples files for new features additions
      • Plugins and templates now have their own README.md to not overload global one
    • #82 Action now reuse previously built images for forks and unreleased versions to save time in multiples jobs workflow
    • #83 Add support to pass token: NOT_NEEDED to skip core and base content, making it possible to use non GitHub-related plugins as standalone without a GitHub token

🧰 Fixes

  • 1608b8b Fix an issue with topics plugins where when topics limit was not reached it displayed And 0 more...
  • 524751c faker.js was wrongly flagged as dev-dependency
  • c075d49 Fix repository template (was broken because of a change in setup)
  • 5c3ecf9 GitHub cakeday is now displayed only for account and repositories older than one year
  • 5619da4 Fix repository template when repository is empty
  • 4763173 Fix stargazers plugin where it was only taking last 2 repositories (hardcoded test)

💪 Contributors

👏 Achievements

Reached 100k+ downloads and 2k+ stargazers!
Thanks to everyone 🎉 !

metrics - Version 3.2

Published by lowlighter almost 4 years ago

📦 New features

  • Added new Activity plugin !

    • Display all of your recent activity on GitHub, like :
      • Pushed commits
      • Opening/Reopening/Closing of issues and pull requests
      • Creation/Deletion of git tags or git branches
      • Pushed commits
      • Publication of new releases
      • Review of pull requests
      • Comments on commits, issues and pull requests
      • Edition of wiki pages
      • Forking and starring of repositories
      • Addition of new collaborators in a repository
      • Repositories made public
    • Limit displayed events with plugin_activity_limit and plugin_activity_days options
    • Filter displayed events with plugin_activity_filter
  • Added new People plugin !

    • Display your followers and the users you're following on GitHub !
    • Use plugin_people_types to choose whether to displayed followers, following or both
  • Miscelleanous

    • Added new option committer_branch to allow pushing generated metrics on a custom branch
    • Added new option config_order to order metrics content
    • Added new option repositories_forks to include forked repositories in metrics
  • Repository template

    • Added support for pagespeed plugin
    • Added support for languages plugin
    • image

🦑 Miscellenous

  • Fixed an issue where PageSpeed plugin was always resulting in 400 if no token was provided
  • Fixed an issue with plugin_habits_days which was actually using the value of plugin_habits_from instead
  • Fixed several visual issues with stargazers plugin
  • config_padding can now be used to configure both height and width padding, instead of height only
  • Removed constraint ownerAffiliations: OWNER to include organizations repositories in metrics
  • Refactored mocked data with Faker.js
    • Placeholder on web instance are now rendered again client side with mocked data
  • Simplied web instance home page for better browser support

💪 Contributors

metrics - Version 3.1

Published by lowlighter almost 4 years ago

📦 New features

  • Added new plugin stars !
    • Display your recently starred repositories !
    • image
  • Added new plugin stargazers
    • Display your stargazers evolution across all of your repositories !
    • It even works with the repository template if you want to display the stargazers evolution of a single repo
    • image
  • New redesign of the web instance !
    • image

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 3.0

Published by lowlighter almost 4 years ago

📦 New features

  • Gists plugin

    • Add new metrics files and comments
    • image
  • Topics plugin

    • Add new option plugin_topics_mode
    • Add new mode mastered to display starred topics as Mastered technologies and topics with icons
    • Pass plugin_topics_limit: 0 to display all topics
    • image
  • *PageSpeed plugin

    • Add new option plugin_pagespeed_screenshot to display a screenshot of audited website
    • image
    • Add new option plugin_pagespeed_url to specify a different website that the one attached to GitHub account
  • Projects plugin

    • Add new option plugin_projects_repositories where you can list repositories projects
    • image
  • Posts plugin

    • Add new option plugin_posts_user to specify a different user that the one attached to GitHub account
    • Fix display issue caused by the change of year
  • Tweets plugin

    • Add new option plugin_tweets_user to specify a different user that the one attached to GitHub account
  • Repository template

    • Add new template repository for specifically displaying additional metrics for a single repository
    • image
  • Miscelleanous

    • Add support for users with more than 100 repositories
    • Improved support for Halloween
      • Add new --halloween debug flag
      • Isocalendar now support halloween colors
      • image
    • SVG heights are now computed dynamically to avoid cropped outputs and empty spaces
      • Use new option config_padding to adjust the size of your image in case you still have display issues
    • Add new option config_animations to allow disabling of animations
    • Add new option config_output to convert SVG into PNG/JPEG output
    • [Experimental] The action now use GitHub registry with already built images for released versions to decrease runtime (from ~5 min to < 30 secs)
      • Unreleased versions and forks will still rebuild the docker image each time

🦑 Miscellenous

  • Heavy paths refactors
    • Everything was moved to /source
    • GraphQL queries is now in /source/queries
    • Web assets are now in /source/app/web
    • Action is now in /source/app/action
  • GitHub action isn't built anymore and is called directlty with node
  • Integration tests now use mocked data to avoid consuming APIs requests and to avoid the use of secrets
    • Refactor all tests with jest
  • Templates and Plugins indexes are now loaded dynamically

💪 Contributors

metrics - Version 2.9

Published by lowlighter almost 4 years ago

📦 New features

  • Now celebrating your GitHub account registration with rainbows !
    • image
  • Added new plugin tweets !
    • Display your recent tweets on your GitHub profile !
    • This use the twitter username you associated to your GitHub account
    • image
  • Plugin habits has new features
    • plugin_habits_from max cap has been increased from 100 to 1000
    • plugin_habits_days allows you to filter the time window you want to keep, up to 30 days
    • plugin_habits_facts allows you to display tidbits deduced from your recent activity (previous behaviour)
    • plugin_habits_charts allows you to display charts of your commit/language activity !
    • image
  • Add support for config_timezone/config.timezone
    • Configure a timezone for more accurate metrics !
  • Terminal template
    • Now supports plugin_pagespeed_detailed option
    • Now supports plugin_gists option
  • Added new debug_flags option

🦑 Miscellenous

  • Removed opacity style which caused weird display issues on iOS
  • Docker image has been updated
  • Improved handling of plugins errors, most of external API now return the error message
  • Added more logs

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.8

Published by lowlighter almost 4 years ago

📦 New features

  • Header now display Available for hire ! when you opted-in on your account
    • image
  • Languages plugin has been updated
    • plugin_languages_ignored option allows you to ignore a comma-separated list of languages
    • plugin_languages_skipped option allows you to ignore a comma-separated list of repositories

🦑 Miscellenous

  • GitHub action should now be able to update generated files larger than 1Mb
  • Web instance has been updated
    • A lot of routes has been renamed
    • Remaining GitHub requests are now displayed in the bottom of screen
    • Missing plugins options were added
    • yml auto-generated for action config was updated

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.7

Published by lowlighter almost 4 years ago

📦 New features

  • GITHUB_TOKEN is now supported, no need to use token with additional permissions, yay 🎉
    • plugin_selfskip has been removed since it's now useless

🦑 Miscellenous

  • Updated documentations (fix typo, updated images and steps, etc.)

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.6

Published by lowlighter almost 4 years ago

📦 New features

  • Plugin pagespeed

    • Add new option plugin_pagespeed_detailed to display additional pagespeed audits result
    • image
  • Web instance improvements

    • Display display version number
    • Use prefers-color-scheme browser setting to auto-select appropiate color scheme
    • Add support for pagespeed.detailed
    • Style improvements

🦑 Miscellenous

  • Debug log are now displayed in case of action error
  • Workflow test cases are now generated and tests master and latest
  • Renamed in code all computed.plugins to plugins to be less verbose
  • Fix handling of boolean string in web instance (always considered as truthy)
  • Additional checks where added to PageSpeed plugins

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.5

Published by lowlighter almost 4 years ago

📦 New features

  • Add new plugin topics
  • Add new plugin projects
    • Display your personal projects progress !
    • image
  • Plugin isocalendar
    • Add new option plugin_isocalendar_duration which can be set to half-year (default) or full-year

🦑 Miscellenous

  • Fix placeholder image for web instance
  • Fix base option for both web instance and GitHub action

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.4

Published by lowlighter almost 4 years ago

📦 New features

  • Add new plugin gists
    • Display your gists metrics !
    • image
  • Add new repositories metrics
    • Add new metrics Sponsors
    • Add new metrics Releases
    • image
  • Some icons were updated or changed
  • Fix previous metric Sponsorships which was using an incorrect value

🦑 Miscellenous

  • Indexes for plugins and templates are now auto generated with npm run build
  • Switched to babel-minify for action minification
  • Bypass cache control for placeholder on server instances

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.3

Published by lowlighter almost 4 years ago

📦 New features

  • Add new plugin posts
    • Display your recent posts from dev.to !
    • image
  • Add new plugin isocalendar
    • Display your commit calendar in an isometric view, along with a few additional stats
    • image
  • New metrics storage replace gists number for classic template
    • Display the total disk storage used by your repositories !
    • image

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.2

Published by lowlighter almost 4 years ago

📦 New features

  • Add new plugin music
    • Display your recently played music on Spotify
    • image
    • Display your favorites tracks from an Apple Music or Spotify playlist
    • image
  • Add new template terminal
    • Discover an awesome animated unix-themed metrics template !
    • image
  • Smarter placeholders and improved design for server app
  • Created new namespace base which contains defaults sections (header, activity, community, repositories, metadata) which allows to show/hide them
    • Use base option in Github Action
    • User base.<section>=0 on Server app
  • Server app can now generate the workflow.yaml to setup as GitHub action
  • Add verify option which allows to test SVG parsing
  • Add dryrun option to allow the SVG generation without commits (used for testing)
  • Add plugin_errors_fatal option to make build fail upon plugin errors
  • Action now uses the github.context to know to which repo it should push the generated SVG, instead of using user/user
  • Add supports for custom embed fonts
  • Add support for haloween colors
    • image

🦑 Miscellenous

  • Server app now ask for cache flush before generating metrics
  • Moved common templating out of classic template
  • package.json is now loaded through setup
  • Fix template and optimize options for action
  • Placeholder now use the image.svg to generate metrics with placeholder data
  • Refactored server app to split index.html
  • Svg size is now computed again from templates
  • Improved tests
  • Action now use its own docker image

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.1

Published by lowlighter almost 4 years ago

📦 New features

  • No plugins will be enabled by default
    • followup and languages will need to be enabled manually
  • Minor improvements on server app page
  • You can now pass the number of repositories you want to use to compute metrics (defaults to last 100)
    • Use repositories option in GitHub action
    • Use ?repositories= option in Server app
  • Coding habits plugin events now default to 100 instead of 50
  • Coding habits plugin from option can now be configured through parameters
    • Use plugin_habits_from option in GitHub action
    • Use ?habits.from= option in Server app

🦑 Miscellenous

  • Setup logs can be hidden
  • Test suite has been improved to include all plugins tests

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 2.0

Published by lowlighter almost 4 years ago

📦 New features

  • Most used languages is now the languages plugin
    • To keep consistency with previous version, this plugin is enabled by default
  • Issues opened/closed and Pull request opened/merged metrics are now in the followup plugin
    • To keep consistency with previous version, this plugin is enabled by default
  • Server app has been redesigned to work with Vue.js
    • Query params are now parsed correctly to allow explicit opt-out for enabled plugins

🦑 Miscellenous

  • Updated SVG height computations
  • Minor fixs

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 1.9

Published by lowlighter almost 4 years ago

📦 New features

  • Add template option
    • Add support for classic template (default)
    • (This option is intended for future usage when new templates will be added)
  • Footer now display whether private contributions have been included in generated metrics

🦑 Miscellenous

  • Rendering are now fully made with EJS
  • SVG image size is now updated in plugins code instead of being directly computed in SVG template
  • Server index now points to location.href instead of metrics.lecoq.io
  • Configuration has been gathered into src/setup.mjs
  • Agnostic src/metrics.js

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 1.8

Published by lowlighter about 4 years ago

📦 New features

  • SVG optimization can now be disabled if wanted
  • GitHub Action improvements
    • user is now optional and will be defaulted to authenticated token user
    • Commits with message [Skip GitHub Action] will now be ignored by default without the need to put a conditional statement in workflow
    • YAML booleans are now converted into JavaScript booleans to ensure they are correctly treated
    • Additional logs for were added
    • Updated action.yml descriptions
    • All params are now optional, with the exception of token*
  • PageSpeed token is now optional when plugin pagespeed is enabled
    • Although it is now optional, it is still advised to provide it to avoid 429 HTTP errors
  • Add new selfskip plugin
    • This plugins will substract all authored commits with token account from your personnal repository tagged with [Skip GitHub Action] in case you don't use a bot token

🦑 Miscellenous

  • Integration tests now check that GitHub action has been rebuild

* The defaults GITHUB_TOKEN seems to have missing rights to perform required actions for this GitHub Action, but a future release may not need to provide anything at all.

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 1.7

Published by lowlighter about 4 years ago

📦 New features

  • Add new plugin habits
    • Display prefered indent style
    • Display most active hour for commits
    • image
  • Server side errors for plugins are now rendered as An error occured on metrics instead of returning a 503
    • image

🦑 Miscellenous

  • SVG image size is more accurate
  • Minor index change for server instances

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 1.6

Published by lowlighter about 4 years ago

📦 New features

  • SVG images are now optimized with SVGO
  • Served images from instance are now compressed

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 1.5

Published by lowlighter about 4 years ago

📦 New features

  • Add a home page for server node instead of redirecting to this repository directly

🦑 Miscellenous

  • Minor style changes and formatting

💪 Contributors

  • @lowlighter (maintainer)
metrics - Version 1.4

Published by lowlighter about 4 years ago

📦 New features

  • Plugins errors are now handled gracefully
    • On non-fatal errors, SVG will still be generated but will print an error message in plugin field :
    • image
  • Add new issue comments statistic in Activity section
  • Add new organization member statistic in Community section

💪 Contributors

  • @lowlighter (maintainer)