Proposal should consider:

• [] terminal output

• [] web app

• or [] static page (github pages)

• [] public repo output

• [] private repo output

For that should:

• [] Create a user journey
• [] Create a simple mockup

Description

To clone GitHub repos in a temporary directory to be analised/ linter

• cleanup

GitHub Actions

• add upload-artifact github action
• run github action once a day

Code improvement

• make organization an (required) parameter ($ node src/index.js --org saucelabs)

Improve README with project information and details about how to use it and adapt for one own project

Description

Should console.log something like:
Repository: automated-oss-quality-check passed all 10 the tests
repository url <repository.git>

Acceptance criteria

• [] Should be easy to read
• [] Should contain detailed information about the tests that passed

Description

Should have a friendly way to add maintainer to repositories, when non is found

Questions around this issue

1. should teams be maintainers?
2. how can OSPO help binding a maintainer?
3. should be manual or automatized?
4. how to automatize without a "one fits all solution"?

Acceptance criteria and possibilities

• [] should be done in a friendly way
• [] should have someone responsible

Description

Should console.log detallied information about failure tests. Should return something like:

Repository: automated-oss-quality-check failled 3 tests
Failled tests:

• README.md
• License
  repository url <repository.git>

Acceptance criteria

• [] Should be easy to read
• [] Should contain detailed information about the tests that failed

Filter:

• [] per type of check (License, Contribution, etc)
• [] per repository

Use GitHug pages to rapid prototype and show the project MVP

Create a mockup for a web application

If all tests passed, return global simple response: all checks passed

Description

User should be able to choose which repos or group of repos should be verified

To be defined

1. Which kind of filter should it be? By name? By teams? By code owners?
2. How is the filter going to be available? in GUI? As a prompt? As a command?
3. Should return a report to the user? How? In terminal? By email? As issue in the repos?
4. If it fails, should proceed as in the automated check, creating an issue in the failed repo? Or just to the user who want to know?

Acceptance criteria

• [] should be able to lint and give a feedback only about the chosen repos

Description

Enable automated check in local repositories

To be defined

1. How should path be passed?
2. How is the report return?

Now code works with a fixed input
This should allow users to choose which repo should be checked

Description

Create error report when linting fails

To be decided

1. To whom is this report addressed to? Code owners? Teams? OSPO?
2. Which format should this repost be? Email? Issue? GitHub notification?

MVP should:

• [] Lint all public repositories using custom ruleset
• [] Show readable results in terminal
• [] Be integrated with GitHub pipeline

Create a Vue.js component able to filter JSON file data (mock) and render in Dashboard/ Home page

Should contain:

• [] A sum of the repositories which had all tests passed in number

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:

• [] Clone reference file as .md

Project Acceptance Criteria

• [] Should be able to verify the existence of the following .md files: code of conduct, contributing, readme, security, changelog, support
• [] Should be able to verify the existence of the following files: license, maintainers or codeowners
• [] Should be able to tests if project uses SemVer
• [] Create a script to daily checks and notifies OSPO in case of a failure on our repositories
• [] Should be tested
• [] Should run locally and over github repos
• [] Should be able to check keywords within the code of conduct: diversity, friendly, etc
• [] Should check if the type of license is valid according to OSPO guidelines: AFL, Apache, BSD, MIT, MS-PL, ISC, PHP License
• [] Should not pass if contains: AGPL, Commons Clause, WTFPL and Beerware, has no license
• [] Should check if there is an attribution to a “Maintain” role inside of the codeowner file
• [] Should use GitHub workflow
• [] Should use GitHub API to check if a new repo has being added and has OSPO approval
• [] Should tests achieve at least 90% coverage

• [] Add rule: check if repository has semantic versioning

Reference: https://github.com/krusty-krab/semver-check/blob/master/index.js

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

Description

Data returning from repolinter is not accurate.
Apparently the issue is that de code version in dependency is not temporally cloning the repository

How to reproduce the bug

1. Compare repolinter of model repo (such as: https://github.com/saucelabs/new-project.git ) in bash (repolinter lint -g https://github.com/saucelabs/new-project.git) with results from using dependency (node src/index.js )

Possible solutions

1. Open issue on repolinter github
2. Create utils to temporarily clone the repo

Description

Create end to end test to check if requests are correctly made

To be defines

1. using what?
2. is returning the proper URL enough end2end?

Description

A issue should be automatically created in the repository when the linting doesn't pass

Acceptance criteria

• [] an issue should be automatically created
• [] issue should contain an explanation about how to be solved
• [] issue title should be clear and simple

Description

Should be able to execute repolinter after cloning repository

Add a Vue.js project

Dashboard should contain:

• [] Total of repositories analised in numbers
• [] Total passed in number

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

Description

Should console.log something like:

Repository: automated-oss-quality-check failled tests

Acceptance criteria

• [] Should be easy to read

This may be solved using pagination

Description

Should console.log something like:
Repository: automated-oss-quality-check passed all the tests
repository url <repository.git>

Acceptance criteria

• [] Should be easy to read

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

Description

Automated check should be able to access all Sauce Labs repositories

Acceptance criteria

• [] should be able to do the same actions as in public repos

Create ruleset to lint only what matters to Automated check

• [] Should show total of fails in number

• Global all passed
• [] createJsonFile()

Description

Create base unit tests to iterate on them

Tests

• unit tests for utils file (use jest)
• enable test coverage check (new features have to have the same or higher test coverage)

Rules

• [x]remove security rule from linting
• [] update changelog rules so that it checks for either CHANGELOG.md or for releases with text