Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Crawler: How to create the deprecation history of an already existing project #36

Closed
8 tasks
BioPhoton opened this issue Aug 6, 2020 · 1 comment
Closed
8 tasks

Comments

@BioPhoton
Copy link
Collaborator

BioPhoton commented Aug 6, 2020

For a new repository, the crawling process is pretty fine so far.
For already existing repository we need to run a bit different process.

The following assumptions are taken into consideration regarding the versioning and location of releases.

A list of release could be found in:
a) github releases
b) npm releases
c) ask the user to select a list of tags/release

For now, we start with c) and assume that a tag is the same as a release.

Preconditions:

  • We can only crawl a branch of the target repo. No PR.

TODOS:

  • Fetch all tags execSync('git tag').toString().trim().split('\n')
  • Show all tags as multi-choice ordered by date
    • User selection step
  • Crawl all selected branches
    • detect already crawled deprecations from older branches by the ruid (same ruid means already crawled earlier but not persisted)
    • 💡 Optionally crawl only the diff from 2 tags so we don't recrawl already crawled deprecations
  • Persist the collected deprecations to the repo (master)
    • persist git tag and data to the deprecation object itself
@BioPhoton BioPhoton changed the title Crawler: How to create the deprecation hostory of an already existing project Crawler: How to create the deprecation history of an already existing project Aug 6, 2020
@BioPhoton
Copy link
Collaborator Author

Closed in favor of #37

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant