Potential improvements

[domoscargin]

Things that are in process

Code refactor

#20 adds a RepoData class and abstracts away some of the more complex stuff.

Better input data

#37 adds service information from X-GOVUK to the input data

Better output data

WIP for adding key data summary

Analyse GOV.UK ports as well

WIP

Things that could still be done

Security

• Implement our own dependents scraper
  • We'd also be able to optimise files here
• Do our own PR

Interaction with the rest of our products

• Figure out ownership and maintenance of repo - do we need to move this onto the govuk-frontend repo?
• Investigate exporting data to AirTable
• Gather final requirements for data fields

Data and data quality

• Try and gather some details from the GitHub repository API call - name, description, etc
• Validate against Cross GOVUK data? https://github.com/x-govuk/govuk-services-frontend-stats

Code quality and optimisation

• The whole getting versions from lockfiles logic is hella complex and messy - could do with a clean up

Testing

• Script integration tests

Caching

• SPIKE database approach ([SPIKE] Add caching and key data storage with SQLite #24)
• SPIKE eTags/conditional query approach
• SPIKE just using JSON files and checking the updatedAt field

Automation

• Automate updating input data
• Automate the running of the script
• Automate the running of the dependents info script
• Implement a "verbose" mode for logging (essentially what we do now!) and keep it quiet as standard