Skip to content

GitHub/FTPの運用

SORCERIAN Next edited this page Sep 18, 2018 · 38 revisions

アップロードルール

共通

  • 当面はGitHub/FTP共に、更新時にDなどでお声がけください(GitHubは履歴が残るので、慣れてきたらルール変更しますが、当面はトラブル防止のため、念のため)
  • いずれの環境も容量が少ないため、大容量のファイルUpは避けてください(いずれの環境もマスター/本番環境なので、バックアップ、作業/一時ファイル、テストファイルなどは小サイズでもお避け下さい。ストレージ用途はあくまでOneDriveで)
  • SText本体の動作に支障をきたす可能性があるので、「更新可能なファイル」(後述)以外の変更はお避け下さい。
  • 新規のシナリオフォルダーをUpする場合には、事前にご要望のシナリオidをお教えください(ほぼ大丈夫だと思いますが、将来的に想定しているフォルダーとのバッティングを避けるため)。
  • 基本、GitHub(開発環境)→FTP(本番環境)の順序で更新願います(ただし、stext.xmlなどサイトの見え方を確認しながら短時間に何度も更新する場合は、例外的には逆もあり)。

GitHub

開発環境です(開発時もこちらを参照しています)

  • 更新可能なファイルは、/stext フォルダー(https://github.com/snext1220/stext/tree/master/stext )配下の自シナフォルダー配下、及び、stext.xml(後述)のみと致します。
  • シナリオフォルダーを変更した場合、即座に本番環境に反映させるかどうかは事前テストの要否によってご判断ください(本番環境での直接テストでも十分な場合はそのままFTPに挙げて戴いて構いません)。もしFTPへのUpを保留する場合も、1~2Wのラグで同期するようにしてください(両者が長期間にわたって異なる状態であるのは避けたい)。
  • stext.xmlを編集した場合には、即座にFTPにもUploadをお願いいたします(保留はしない)。
  • 将来的には、作成戴いた画像などのUpも直接お願いするかも(主に、ときのじさんへ)
  • ここで更新した内容はGitHub Page(https://snext1220.github.io/stext/ )に反映されます。ただし、若干のタイムラグがある感じ?
  • すべての履歴が残るため、履歴の嵐にならぬよう、(もし行う場合も)アップロード等のテストは最小限にお願いいたします。
  • 同じく履歴の嵐を避けるため、同種の修正を何度もUpするのは避けてください(誤字修正など。手元、Playgroundで確認してからのUpをご協力願います)。

FTP

本番環境です。web-deli.comにそのまま反映されるので、シナリオ更新は十分なテストの上でお願いします。

  • 更新可能なファイルは、自シナフォルダー配下、及び、stext.xmlのみと致します。
  • その他はGitHub側で触れているので割愛します。

stext.xml

シナリオの基本情報を表すデータで、STextページ(stext.aspx)の表示はここでの情報を利用しています。ファイルの破損によって、STextページが正しく表示されなくなる可能性があるので注意してください。

以下は、stext.xmlの構造です。

  • stext ルート要素
    • scenario シナリオデータを束ねる要素
      • work 個々のシナリオ情報(複数列挙)
        • @id シナリオid(未公開時は任意)
        • @title シナリオのタイトル
        • @author 著者名
        • @guest ゲストの著者か(現在は未使用。将来は表記の制御に利用するかも)
        • @unpublished 未公開か(futureから引き継ぎで完成予定日を「2018年12月」の形式で。公開時は属性そのものを削除)
        • #text 紹介文(基本、Markdown形式ですが、画像埋め込み、赤字などはHTMLでの記載が必要)
    • utility ユーティリティのデータを束ねる要素
      • work 個々のユーティリティ情報(利用できる属性等はシナリオのものに準ずる。以下、utility固有の説明)
        • @id Util 5のようにシナリオ扱いのものを除いては不要
        • @backup バックアップ機能にリストアップするもの(値は固定でtrue)
    • future まだタイトルのみのシナリオ情報(今後のリリース予定に表示。紹介文入ったものは、scenario配下へ移動)
      • work 個々のシナリオ情報(利用できる属性等はシナリオのものに準ずる。以下、future固有の説明)
        • @title、@author これらのみ必須
        • @unpublished 完成予定月を入力。未定の場合は省略可
        • #text 紹介文は入れても構わないが、入れたものはscenario配下に移動の事