Check My Repo is a tool for OSPOs - Open Source Program Offices - to automatically check their repositories health and quality. Built upon Repolinter and using open source best practices as reference, this tool verifies if all public repositories under an organization contains:

• [] Readme.md file
• [] Changelog.md file or uses GitHub Releases
• [] Codeowners file with a “Maintain” role
• [] License file
• [] Security: if does not have binaries
• [] Test directory

Although part of best practices, as all Sauce Labs repositories are under SauceLabs:

• Code of conduct
• Contribution guidelines
• Support file This tool does not check for those files, but they can easily be implemented on your project by adding them into repolinter.json configuration file, using repolinter dafault file.

This application can run locally or under a GitHub pages. When running locally, it nicelly shows you the results in terminal. It also generates a frontend.json file with an array of objects containing the filtered results of this verification process.

It uses this same frontend.json file to send data to our frontend application made with Vue.js This is SauceLabs OSPO Check-My-Repo website. It is setup to daily lint all of our respositories and re-deploy to the page above using GitHub Actions CI/CD. This means that information is updated daily automalicaly.

This project is build with

• Node.js v14
• Vue.js 3 cli
• Repolinter
• Octokit
• GitHub Actions CI/CD

1. Clone this project

git clone https://github.com/saucelabs/check-my-repo.git

2. Install dependencies

npm install

3. Run script

node src/index.js

It enables you to verify all Sauce Labs public repositories, as it is set up as default. If you would like to check your own organization repos, run:

node src/index.js <your organization github name>

You can also change the code at src/index.js line 19, to your organization's name

const organization = process.argv[2] || 'saucelabs'

4. Open frontend folder

cd frontend

5. Install dependencies

npm install

6. Run server

npm run serve

7. Open in browser network link provided in terminal

Cmd + click

8. Click Repositories button to check all repositories fail results or Healthy Repos button to see the list of all of your fully healthy repositories

If you have any questions or comments, get in touch with us opensource@saucelabs

You need to have Node.js install version 12 or latter. This project is currently using version 14. To check if you have and which Node.js version you can type:

node -v

To run tests, run

npm test

Under .github/workflows you will find 3 actions:

• One that run tests on every commit And 3 others that: checks the repositories, overwrites the frontend.json file, sends it to frontend than deploys the new data to GitHub pages
• One when a push is made to main branch
• One daily at midnight (cron time)

It now uses Sauce Labs environment variables. You can change the information for your organization one by changing the following values (just for deployment actions):

with:
          publish_branch: gh-pages
          user_name: 'OSS Sauce Bot'
          user_email: '[email protected]'

If you would like to know more about how to deploy Vue.js to GitHub pages and how to set up GitHub Pages from your repository, I recommend the following articles:

• Deploying Vue Apps to Github Pages, by Bobby
• Vue CLI documentation for deployment
• Getting started with GitHub Pages

Please read CONTRIBUTING.md for details on our process for submitting pull requests, and please ensure you follow the CODE_OF_CONDUCT.md.

We use SemVer for versioning. For the versions available, see the tags on this repository.

This project is licensed under the MIT License - see the LICENSE.md file for details

• Thanks to Todo Group for developing Repolinter and kindly supporting us during this development.