Skip to content

Refactor brigade-project-index loader to use a gitsheets API #33

Open
@themightychris

Description

@themightychris

This script makes really limited use of gitsheets as a node module to materialize some tables from evolving online data: https://github.com/codeforamerica/brigade-project-index/tree/loader

This illustrates a major early use case for gitsheets though: as a data backend for civic tools and services.

This is proof-of-concept level code, and it does a lot of stuff directly with git that could be made a lot more pleasant with some of the plumbing wrapped up in an expressive gitsheets module API

  • Get set up to run and debug the loader locally
  • Use gitsheets api to generate more useful commit messages on the index like 🔁 added 1, updated 3 projects from Open Savannah (this example might be accomplished by passing a template for the auto-commit-message generator or making a call to get the generated to use in a sep commit command)
  • Make other revisions to taste to the public gitsheets module API to make for more readable code in the consumer (the loader script)
  • Ship a minor version bump to the gitsheets backend to npm adding module API enhancements
  • Open a PR against the loader inside the cfa repo

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions