Skip to content

GregTrevellick/ReadMeSynchronizer

Repository files navigation

Read Me Sychchronizer

Get more details at codescene.io.

Read Me Synchronizer BetterCodeHub compliance Codacy Badge CodeBeat CodeFactor CodeScene Code Health CodeScene System Mastery LGTM Alerts Language grade: JavaScript GitHub top language Github language count GitHub actions GitHub issues GitHub pull requests GitHub followers GitHub stars GitHub watchers Sonar&metric=alert_status Sonar&metric=bugs Sonar&metric=code_smells Sonar&metric=coverage Sonar&metric=duplicated_lines_density Sonar&metric=ncloc Sonar&metric=reliability_rating Sonar&metric=security_rating Sonar&metric=sqale_index Sonar&metric=sqale_rating Sonar&metric=vulnerabilities Appveyor Build status Appveyor unit tests Azure Build Status Hound Access Lint github ImgBot Renovate Bot github Charity Ware License Subscribe

Overview

A typescript app containing gulp tasks that will update the badges in your local README.md files within your local git repositories.

This means the repo-owner can :

  • manually test all their badges, both cosmetically & functionally, quickly from one place rather than the slow process of checking each repo individually
  • ensure badge consistency across many repos
  • easily spot problems (failing builds, failing tests, long running branches, etc) with any of their repos all in one place

Bonus Feature

Given this app will cause changes to multiple repos, I added gulp tasks to do the following:

  • Undo all the README.md files at once
  • Commit all the README.md files at once
  • Pull all the repos at once
  • Push all the repos at once

Why ?

The act of creating this repo allowed me to create my first from-scratch typescript app, and learn more about typescript, gulp & npm along the way.

What Next ?

At some point I may try to make a generic scaffold app from this repo, and publish it as a template on Visual Studio Marketplace and/or Yeoman.

Credits

Anton Tishchenko

loune.net

Microsoft Dev Labs

Shields.io

Stef Heyenrath