https://github.com/GregTrevellick/ReadMeSynchronizer
Keeps badges in ReadMe files across all my repos in sync.
https://github.com/GregTrevellick/ReadMeSynchronizer
badge badges git git-repository-manager readme repositories synchronisation synchronization
Last synced: 5 months ago
JSON representation
Keeps badges in ReadMe files across all my repos in sync.
- Host: GitHub
- URL: https://github.com/GregTrevellick/ReadMeSynchronizer
- Owner: GregTrevellick
- License: other
- Created: 2018-07-26T07:08:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T06:05:17.000Z (6 months ago)
- Last Synced: 2024-10-17T17:50:01.785Z (6 months ago)
- Topics: badge, badges, git, git-repository-manager, readme, repositories, synchronisation, synchronization
- Language: JavaScript
- Homepage: https://github.com/GregTrevellick/AllBadges
- Size: 14.2 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- jimsghstars - GregTrevellick/ReadMeSynchronizer - Keeps badges in ReadMe files across all my repos in sync. (JavaScript)
README
## Read Me Sychchronizer
[ Get more details at **codescene.io**.](https://codescene.io/projects/4316/jobs/latest-successful/results)
[](https://github.com/GregTrevellick/ReadMeSynchronizer)
[](https://bettercodehub.com/results/GregTrevellick/ReadMeSynchronizer)
[](https://www.codacy.com/project/gtrevellick/ReadMeSynchronizer/dashboard?utm_source=github.com&utm_medium=referral&utm_content=GregTrevellick/ReadMeSynchronizer&utm_campaign=Badge_Grade_Dashboard)
[](https://codebeat.co/projects/github-com-gregtrevellick-readmesynchronizer-master)
[](https://www.codefactor.io/repository/github/GregTrevellick/ReadMeSynchronizer)
[](https://codescene.io/projects/4316)
[](https://codescene.io/projects/4316)
[](https://lgtm.com/projects/g/GregTrevellick/ReadMeSynchronizer/alerts/)
[](https://lgtm.com/projects/g/GregTrevellick/ReadMeSynchronizer/context:javascript)
[](https://github.com/GregTrevellick/ReadMeSynchronizer)
[](https://github.com/GregTrevellick/ReadMeSynchronizer)
[](https://github.com/GregTrevellick/ReadMeSynchronizer/actions)
[](https://github.com/GregTrevellick/ReadMeSynchronizer/issues)
[](https://github.com/GregTrevellick/ReadMeSynchronizer/pulls)
[](https://github.com/GregTrevellick?tab=followers)
[](https://github.com/GregTrevellick/ReadMeSynchronizer)
[](https://github.com/GregTrevellick/ReadMeSynchronizer/watchers)
[](https://sonarcloud.io/dashboard?id=ReadMeSynchronizer)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=bugs)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=code_smells)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=Coverage)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=duplicated_lines)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=ncloc)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=reliability_rating)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=security_rating)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=sqale_index)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=sqale_rating)
[](https://sonarcloud.io/component_measures?id=ReadMeSynchronizer&metric=vulnerabilities)
[](https://ci.appveyor.com/project/GregTrevellick/ReadMeSynchronizer)
[](https://ci.appveyor.com/project/GregTrevellick/ReadMeSynchronizer/build/tests)
[](https://gregtrevellick.visualstudio.com/ReadMeSynchronizer/_build/latest?definitionId=24)
[](https://houndci.com/)
[](https://www.accesslint.com)
[](https://imgbot.net/)
[](https://renovatebot.com/)
[](https://github.com/GregTrevellick/MiscellaneousArtefacts/wiki/Charity-Ware)
[](/LICENSE.txt)
[](https://github.com/GregTrevellick/ReadMeSynchronizer/subscription)
[](https://codescene.io/projects/4316/jobs/latest-successful/results)
## 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](https://marketplace.visualstudio.com/vs) and/or [Yeoman](http://yeoman.io/).
### Credits
[Anton Tishchenko](https://sagittarius.agency/blog/cicd-for-your-sitecore-pet-project-using-appveyor)
[loune.net](https://loune.net/2011/02/match-any-character-including-new-line-in-javascript-regexp/)
[Microsoft Dev Labs](https://docs.microsoft.com/en-us/labs/devops/sonarcloudlab/)
[Shields.io](https://shields.io/#/)
[Stef Heyenrath](https://medium.com/@stef.heyenrath/how-to-fix-sonarcloud-issue-in-a-github-pr-when-using-appveyor-integration-8909b49406b4)