将google-services.json提交给GitHub

时间:2015-12-13 13:12:50

标签: android github travis-ci google-signin

我正在创建一个公共Android项目,我正在使用Google登录服务。我是根据this tutorial做的。正如它所说,我有google-services.json文件。

  • 我是否需要将上述文件提交给Github?
  • 其他开发者(如果有人贡献)需要此文件吗?
  • 或者,他们是否必须创建自己的?
  • 顺便说一句,我正在使用Travis-CI。此文件是否会影响CI构建?

4 个答案:

答案 0 :(得分:14)

您可以在应用build variant的CI平台上创建新的build.gradle并存储模板google-services.json以用于构建。

为新的google-services.json构建变体使用不同的dev(请参阅this post)。将以下google-services.json模板添加到app/src/dev folder

{
  "project_info": {
    "project_number": "",
    "project_id": ""
  },
  "client": [
    {
      "client_info": {
        "mobilesdk_app_id": "1:123456789012:android:1234567890123456",
        "android_client_info": {
          "package_name": "com.your.package"
        }
      },
      "oauth_client": [
        {
          "client_id": "",
          "client_type": 3
        },
        {
          "client_id": "",
          "client_type": 1,
          "android_info": {
            "package_name": "com.your.package",
            "certificate_hash": ""
          }
        }
      ],
      "api_key": [
        {
          "current_key": ""
        }
      ],
      "services": {
        "analytics_service": {
          "status": 2,
          "analytics_property": {
            "tracking_id": ""
          }
        },
        "appinvite_service": {
          "status": 1,
          "other_platform_oauth_client": []
        },
        "ads_service": {
          "status": 1
        }
      }
    }
  ],
  "configuration_version": "1"
}

请注意,如果您还使用Google Analytics或GCM服务,我已扩展此Google服务。

您将拥有以下配置:

app/
├── src/
│   ├── main/
│   └── dev/
│       └── google-services.json
├── google-services.json
└── build.gradle

您可以使用:

  • 新的构建类型
  • 一种新的产品风味(如果你已有的产品风味)

构建类型

添加以下构建类型:

buildTypes {

    dev {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}

我们不需要在常规构建中构建此“dev”构建变体,因此如果未指定参数,则可以排除此变体。将以下内容添加到您的应用build.gradle

def build_param = "${build}";

if (build_param != "dev") {
    //exclude production build
    android.variantFilter { variant ->
        if (variant.buildType.name.equals('dev')) {
            variant.setIgnore(true);
        }
    }
} else {
    //exclude all except production build
    android.variantFilter { variant ->
        if (!variant.buildType.name.equals('dev')) {
            variant.setIgnore(true);
        }
    }
}

产品风味

dev产品风味添加到现有产品中:

productFlavors {

    full {
    }

    dev {
    }
}

要从常规版本中删除此dev产品风格:

def build_param = "${build}";

if (build_param != "dev") {
    //exclude dev
    android.variantFilter { variant ->
        if (variant.getFlavors().get(0).name.equals('dev')) {
            variant.setIgnore(true);
        }
    }
} else {
    //exclude all but dev
    android.variantFilter { variant ->
        if (!variant.getFlavors().get(0).name.equals('dev')) {
            variant.setIgnore(true);
        }
    }
}

最后,将您的应用模块google-services.json添加到.gitignore

app/google-services.json

我们之前已确保仅在指定参数dev时才会使用此build=dev变体

修改.travis.yml以修改构建配置:

script:
  - ./gradlew clean build -Pbuild=dev

-Pbuild=dev只会使用google-services.json

中的app/src/dev/google-services.json构建开发构建版本

查看正在使用this sample project

google-services Google project

Travis log中,您可以看到正在解析的JSON文件是dev构建变体的文件:

Parsing json file: /home/travis/build/bertrandmartel/android-googlesignin/app/src/dev/google-services.json 

额外注意

请注意,此方法不仅限于CI,并且可以在需要生产google-services.json或其他AndroidManifest.xml时使用fabric.io键等特定属性扩展到生产版本)

检查this method以防止嵌入在AndroidManifest.xml中的结构密钥(并且无法从gradle导入)承诺使用不同的构建变体并使用参数启用生成构建。

答案 1 :(得分:3)

您可以使用travis encrypt-file google-services.json

Documentation

您可以通过以下方式完成:

  • 运行$ gem install travis安装了Travis CI命令行客户端。

  • 使用$ travis login$ travis login --pro

    登录Travis CI

    $ travis encrypt-file super_secret.txt encrypting super_secret.txt for rkh/travis-encrypt-file-example storing result as super_secret.txt.enc storing secure env variables for decryption

然后它将在控制台上打印:

openssl aes-256-cbc -K $encrypted_0a6446eb3ae3_key -iv $encrypted_0a6446eb3ae3_iv -in super_secret.txt.enc -out super_secret.txt -d

您可以像我here

那样将其存储到您的.travis.yml文件中

不要忘记将您的.enc文件放在GitHub存储库中。

如果您有多个文件,可以压缩它们,然后在Travis ci上解压缩解密文件。

例如,您可以这样做:

$ tar cvf secrets.tar foo bar
$ travis encrypt-file secrets.tar
$ vi .travis.yml
$ git add secrets.tar.enc .travis.yml
$ git commit -m 'use secret archive'
$ git push

我做到了。

在我的情况下,我有两个文件用于构建我的应用程序。所以,我使用this因为travis不支持多个加密文件。因此,您在一个文件上压缩并加密此文件。

您可以查看我的travis脚本here

答案 2 :(得分:2)

Firebase 文档说:

“对于开源项目,我们通常不建议将应用的 Firebase 配置文件或对象包含在源代码管理中,因为在大多数情况下,您的用户应该创建他们自己的 Firebase 项目并将他们的应用指向他们自己的 Firebase 资源(通过他们自己的 Firebase 配置文件或对象)。”

https://firebase.google.com/docs/projects/learn-more?authuser=0#config-files-objects

答案 3 :(得分:1)

Firebase 文档似乎暗示将文件提交到 GitHub 没有问题。

这是the docs的摘录

<块引用>

Firebase 配置文件包含您项目的唯一但非秘密的标识符。要了解有关此配置文件的更多信息,visit Understand Firebase Projects.