In order to properly include in the product tree all packages resolved via lsst_distrib, it is necessary to provide the following information, in each package git repository:
- Short name of the package, a text to display in the (yellow box) of the product tree (max 18 characters)
- Suggestion: It could follow the namespace naming rules, but first letter capital
- Key string, 2 to 7 character, it shall be unique, the shorter the better, it has to be used for automatic process building the product tree
- Examples, JCAL for jointcal, ASTMT for astro_metadata_translator, DAFB for daf_butler,
- Reference person(s), someone that has the best knowledge on that software package and is usually maintaining it, 2 references can be given
- Proposed format: github_username (Full Name) [github_username (Full Name)]
The proposal is to add this information in a file, my first thought is a info.yaml in the home folder of each repository.
- is triggering
DM-17682 Update README template
- To Do
- relates to
DM-4875 Give base an updated readme file
DM-14875 What to add to the pipe_tasks readme
DM-4619 Add README, CONTRIBUTING and GitHub summaries to each package
- Won't Fix
- mentioned in
I had a look to the milestone project (in lsst-dm) but I did not find any json with project names.
John Swinbank can you indicate where I can find this information?
Gabriele Comoretto [X] — sorry I didn't see your comment earlier.
I think we discussed this at the DM-CCB yesterday. The only JSON file in https://github.com/lsst-dm/milestones is used to provide information about milestones. I'm not aware of any existing JSON file which defines project (product?) names, although I guess maybe https://github.com/lsst/repos/blob/master/etc/repos.yaml is close?
I think repos.yaml is used for build purposes. Add there information for documentation purpose is not the right thing in my opinion.
Since I will be parsing README files in any cases, I think that this is the most suitable location for the (optional) display_name information, in addition to wbsowner and expert as concluded above.
If I understand correctly from the last comments, the only information we need is: