microbiomedata / nmdc-schema

National Microbiome Data Collaborative (NMDC) unified data model
https://microbiomedata.github.io/nmdc-schema/
Creative Commons Zero v1.0 Universal
26 stars 8 forks source link

Omit derived files from repo (generate them locally instead) #1960

Open eecavanna opened 2 months ago

eecavanna commented 2 months ago

This repository contains several files that are dynamically generated from other files in the repository. This ticket is about omitting those generated files from the repository and, instead:

  1. Documenting how developers can generate them locally as-needed
  2. Updating GitHub Actions to generate them so they are included in the package that gets published to PyPI

Related: https://github.com/microbiomedata/nmdc-schema/issues/1602

One team member suggested that ideas in this area be prototyped in a temporary fork of this repository — so that they can be tested, demonstrated, and discussed without interfering with this repository.