Making a opensource dependency list

[rickmak]

Description

A Skygear version of this: https://www.docker.com/components-licenses

Related Issues

• Server Issues
• Client Issues
• Guides Issues

Progress Tracker

• [ ] Specification Design Approval
• [ ] Write (code + tests + API docs) then get them merged. Put All PR there
  • [ ] Code
  • [ ] Minimal tests
  • [ ] Minimal API Docs
• [ ] Guides. Put All PR there
• [ ] Release
  • [ ] Update release notes
  • [ ] Release

Advice

• Specification Design Approval
  • Once you get LGTM from another Skygear Core Team Member, you can check this checkbox. And apply the "workflow/design-complete" label.
• Coding
  • Use as many PRs as you need. Write tests in the same or different PRs, as is convenient for you.
  • API doc should goes in the same PR with the code.
  • As each PR is merged, add a comment to this issue referencing the PRs.
  • When you are done with the code, apply the "workflow/code-complete" label.
• Guides
  • Write or modify guides and get them merged in https://github.com/skygeario/guides
  • When the PR of guides is merged, check this checkbox and apply the "workflow/guides-complete" label.

[cheungpat]

@rickmak it would be great if you could include the list and/or how you created the list

[rickmak]

I have manually created a list for skygear-server, py-skygear and skygear-SDK-iOS due to some client consulting request. The used lib are as follow.

golang: https://github.com/pmezard/licenses > licenses ./… py-skygear: yolk skygear-SDK-iOS: https://gist.github.com/rickmak/b896d73bd1063cac0efe00dc997356f4 skygear-SDK-JS: nlf

To make the opensource dependency list manageable, I suggest the follow approach:

1. Make all CI script on git tag to upload a files to a agreed place as in API doc.
   1. i.e. skygear-SDK-iOS -> https://docs.skygear.io/ios/reference/{v1.1.2}/license.txt
   2. i.e. skygear-SDK-JS -> https://docs.skygear.io/js/reference/{v1.1.2}/license.txt
   3. …etc
   4. the file can be public, format is open, as long as easy to parse. i.e. tab separate list will works
2. The skygear-doc CD process will fetch the files, the file list is hardcoded.
   1. parse the list
   2. build the html to https://doc.skygear.io/components-licenses