cdnjs / cdnjs/packages

Automate verification of library file map

Open
#1 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

🔍 CI
Dominant language
Shell
Stars
420
Forks
405
Avg merge
3d 15h
Merged PRs (30d)
3

Description

Idea

Currently, when maintainers go to manually review a pull request to add a library, they have to confirm with the PR author that any files missed by the file map are intentionally missed. Additionally, it has to be confirmed that all files falling under the map are also intentionally included.

To save time and automate this process, it would be great if @PeterBot automatically listed files to the author that are not included in the file map as well as the files that the map does pick up to confirm it is intended.

  • Make the PR author aware of files missed by the file map and confirm this is intended
  • Make the PR author aware of files picked up by the map and confirm intention

Relevant Scripts

CI Script: https://github.com/cdnjs/cdnjs-drone-ci/blob/master/cdnjs.sh
PR Review Script: https://github.com/PeterDaveHello/Drone-GitHub-status-report-bot/blob/master/main.sh


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the CI Script at cdnjs.sh and the PR Review Script at main.sh, then trace how the library file map is evaluated. Done means the PR author is shown both files missed by the map and files selected by it for confirmation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, shell
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.