polyfill.js のリリース定義

dynamis commented 6 years ago

現在 WebGPIO, WebI2C の polyfill は polyfill.js ファイルをいくつかの場所に置いてそれを読み込んでいる形になっているが、置き場所とバージョン管理をしたい

[x] 互換性問題があるので (少なくとも過去にはあった＆それでハッカソンの参加者が原因不明のトラブルとして苦しんだことがある) バージョン番号を付けてリリースするようにする
- chirimen 全体のバージョンでも node バックエンドとセットでも polyfill 単体のバージョンでも良いのだけどルールを決めておく
- [ ] github repo で release タグを付けるなど手順を決めておく
  - ファイルは単に github の releases に置くのでよいか。
[x] ファイル名をこの際にもう少し考える
- polyfill.js では何か全く分からない。webgpio.js とかだと API 毎のファイルになってしまうのでヤダ。API 標準化の受け皿としている browserrobo.js とかにするか、hardwarecontrol.js みたいな名前にするのかあたりか
- sleep() 等の汎用ユーティリティは同梱せず別にしておいてそれと concat (pack) したものを chirimen.js とかにするのはどうだろう
[x] バージョン毎のファイルと最新ファイルをホストする場所を決める
- chirimen-1.0.0.js, chirimen-latest.js みたいな感じ？
- 例えば polyfill.chirimen.org とか js.chirimen.org 配下に置くとか？前者は polyfill 配布場所と明確にする糸の名前、後者は polyfill 以外にも今後配付する想定をするならありかもという名前。
- これらは polyfill 開発するリポジトリの github pages (もしくは netlify など) でホスト
- chirimen-raspi3 には最新版だけ入れるのか古いバージョンも一緒に残しておくのか。単純にバージョン番号付きで古いのを全て入れておくでいいか？

tadfmac commented 6 years ago

現在、リリース時に叩くrelease.shでTimestampを生成して、version.txt に保存、srv.js側では起動時にこのversionをconsole.logするようにしているけど、polyfill.js側との自動照合のようなことまではやってないですね。ホスティングについて現在のVersionではrawgit経由で直接参照する方式で上げてますので、CDNのような場所が確保できるなら、デプロイ・参照統一できた方がベターです。(オフラインキャッシュ対応のため、全てのindex.htmlからsw.js呼ぶのか、というあたりが課題のような)

dynamis commented 5 years ago

ファイル名については例えば次のような latest とバージョン番号ありのファイルとを用意することに:

chirimen-raspi3-latest.js
chirimen-raspi3-1.0.2.js

see: https://github.com/chirimen-oh/meeting/blob/master/2018/meeting-2018.08.29.md

dynamis commented 5 years ago

ホスト先は github pages で良いことになった (#47)

https://chirimen.org/chirimen-raspi3/gc/polyfill/chirimen-raspi3-latest.js

chirimen-oh / chirimen

polyfill.js のリリース定義 #29