1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

.gitignoreを使ってパスワードなどを隠す

Discussion in 'Off Topic' started by mfmfneko, 2017-06-05.

  1. 0. 概要
    GitHubでソースコードを公開する場合、例えば開発環境などでデータベースへのユーザー名・パスワードなどを公開したくない時があるかもしれません。(というか、誰しも公開したくはないでしょう。)
    このスレッドでは、ユーザー名やパスワードを隠す方法を記載してあります。

    1. ".gitignore"とは何か
    完結に言えば、これは「Gitのバージョン管理の対象外のファイルを指定する」ものです。
    例えば、ログファイルなどは公開する必要はありませんよね?そういったファイルを指定します。

    2. 事前準備
    ユーザー名やパスワードなど、公開したくない情報をConfigファイルなどに移動しましょう。
    (ソースコードに直接書くのではなく、外部ファイルから読み込むようにしましょう。)

    3. ".gitignore"に追加
    .gitignoreは基本的にはプロジェクト(プラグイン)のルートディレクトリに配置します。
    .gitignoreのコードは、下記のようにしてください。(#はコメント行を表します)
    Code:
    # /database.ymlをGit管理しない
    /database.yml
    4. 以上
    特に難しいことではないと思います。なお、実際に上記の方法を採用する場合は、一度自分自身で実際の挙動を試してみることをオススメします。

    5. サンプル
    https://github.com/mfmfneko/SmallPlugin/tree/master/GitIgnore
     
  2. 理解さえすれば簡単なことだけど説明がしにくい…。ちなみに、Yaml形式になってますが、Jsonでも問題はないです。

    でも「ソースコードを公開 → 他の人も使う可能性がある」ならYaml使うべきだよね。

    ちなみにこのスレッドはお問い合わせの要望で作りました。