saucelabs / check-my-repo Goto Github PK
View Code? Open in Web Editor NEWAn automated tool that verifies Sauce Labs repositories to comply with OSS best practices
Home Page: https://opensource.saucelabs.com/check-my-repo/
License: MIT License
An automated tool that verifies Sauce Labs repositories to comply with OSS best practices
Home Page: https://opensource.saucelabs.com/check-my-repo/
License: MIT License
Filter:
Repolinter does not have a rule to verify SemVer
Find how to check it and add it to custom ruleset at repolinter.json file, in the project root
Rules
Create ruleset to lint only what matters to Automated check
Should be able to execute repolinter after cloning repository
Automated check should be able to access all Sauce Labs repositories
Create end to end test to check if requests are correctly made
Dashboard should contain:
Improve README with project information and details about how to use it and adapt for one own project
Data returning from repolinter is not accurate.
Apparently the issue is that de code version in dependency is not temporally cloning the repository
Enable automated check in local repositories
Create base unit tests to iterate on them
Tests
This may be solved using pagination
Should have a friendly way to add maintainer to repositories, when non is found
Should console.log something like:
Repository: automated-oss-quality-check passed all 10 the tests
repository url <repository.git>
If all tests passed, return global simple response: all checks passed
To clone GitHub repos in a temporary directory to be analised/ linter
Create error report when linting fails
Reference: https://github.com/krusty-krab/semver-check/blob/master/index.js
Now code works with a fixed input
This should allow users to choose which repo should be checked
Should console.log something like:
Repository: automated-oss-quality-check failled tests
A issue should be automatically created in the repository when the linting doesn't pass
Add a Vue.js project
User should be able to choose which repos or group of repos should be verified
Should console.log something like:
Repository: automated-oss-quality-check passed all the tests
repository url <repository.git>
MVP should:
Create a Vue.js component able to filter JSON file data (mock) and render in Dashboard/ Home page
At repolinter.json we define our custom ruleset.
In each rule, if test fails, it is asked to create a new file.
New file is created in the temporary directory.
The new file created should be .md, instead it's creating a huge HTML, I guess cloning all the reference page instead of the file
Todo:
Create a mockup for a web application
Should contain:
Should console.log detallied information about failure tests. Should return something like:
Repository: automated-oss-quality-check failled 3 tests
Failled tests:
At the moment project is using axios to get JSON file from public folder.
There is a mock file in this folder.
But folder should change dinamically: lint -> send files to public -> delete files (clean the folder)
Should also be able to choose which file should be displayed
At repolinter.json we define our custom ruleset.
In each rule, if test fails, it is asked to create a new file.
New file is created in the temporary directory.
It needs to be pushed into the remote/ original repository as a pull request
GitHub Actions
Code improvement
Use GitHug pages to rapid prototype and show the project MVP
Proposal should consider:
[] terminal output
[] web app
or [] static page (github pages)
[] public repo output
[] private repo output
For that should:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.