This section lists the requirements to make this action work and how to meet them.
First of all you will need a Google Service Account for your project. Service accounts are just specific Google account types that are used by services instead of people. To make one go to Service Accounts in the IAM and administration section of the Google Cloud Plattform dashboard and create a new project or choose the one you are already using for your current shenanigans. Click on create new service account and continue with the process. At the end you will get the option to generate a key, we need this key so store it safely. It's a json file whith the following structure:
{
"type": "",
"project_id": "",
"private_key_id": "",
"private_key": "",
"client_email": "",
"client_id": "",
"auth_uri": "",
"token_uri": "",
"auth_provider_x509_cert_url": "",
"client_x509_cert_url": ""
}
Go to your Google Drive and find the folder you want your files to be uploaded to and share it with the GSA. You can find your service account email address in the client_email
property of your GSA credentials.
While you are here, take a note of the folder's ID, the long set of characters after the last /
in your address bar if you have the folder opened in your browser.
This action needs your GSA credentials to properly authenticate with Google and we don't want anybody to take a peek at them, right? Go to the Secrets section of your repo and add a new secret for your credentials. As per GitHub's recommendation, we will store any complex data (like your fancy JSON credentials) as a base64 encoded string.
You can encode jour .json
file easily into a new .txt
file using any bash terminal (just don't forget to change the placeholders with the real name of your credentials file and and the desired output):
$ base64 CREDENTIALS_FILENAME.json > ENCODED_CREDENTIALS_FILENAME.txt
The contents of the newly generated .txt
file is what we have to procure as a value for our secret.
IMPORTANT: This action assumes that the credentials are stored as a base64 encoded string. If that's not the case, the action will fail.
This section lists all inputs this action can take.
Required: YES A base64 encoded string with your GSA credentials.
Required: YES The ID of the Google Drive folder you want to upload to.
I would suggest you store this as an environmental variable or a Github secret
Required: YES The glob pattern for the file(s) to upload.
If multiple files are matched, they will be zipped before upload.
Required: NO
Default: null
The name you want your zip file to have.
- If the
target
input is a file, this input will be ignored.- If not provided, it will default to the folder's name.
This section lists all outputs this action produces. A link to the Drive folder.
A link to the Drive folder.
A direct link to the uploaded file.
This section contains some useful examples.
This a very simple workflow example that checks out the repo and uploads the README.md
file to a Google Drive folder every time there is a push to master.
name: Store readme in Drive
on:
push: { branches: [master] }
jobs:
buildAndTestForSomePlatforms:
name: Upload readme to drive
runs-on: ubuntu-latest
steps:
# Checkout
- name: Checkout repository
uses: actions/checkout@v2
# Upload to Drive
- name: Upload README.md to Google Drive
uses: intersecato/[email protected]
with:
target: README.md
credentials: secrets.<YOUR_DRIVE_CREDENTIALS>
folder: <YOUR_DRIVE_FOLDER_ID>
This a very simple workflow example that checks out the repo and uploads the public
folder as a zip file to a Drive folder every time there is a push to master.
name: Store public in Drive
on:
push: { branches: [master] }
jobs:
buildAndTestForSomePlatforms:
name: Upload public to drive
runs-on: ubuntu-latest
steps:
# Checkout
- name: Checkout repository
uses: actions/checkout@v2
# Upload to Drive
- name: Upload public folder to Google Drive
uses: intersecato/[email protected]
with:
target: public
credentials: secrets.<YOUR_DRIVE_CREDENTIALS>
folder: <YOUR_DRIVE_FOLDER_ID>
This a very simple workflow example that checks out the repo and uploads the public
folder as a zip file to a Drive folder every time there is a push to master. After that, it sends a Telegram message using Telegram Message Notify with a link to the folder.
name: Store public in Drive
on:
push: { branches: [master] }
jobs:
buildAndTestForSomePlatforms:
name: Upload public to drive
runs-on: ubuntu-latest
steps:
# Checkout
- name: Checkout repository
uses: actions/checkout@v2
# Upload to Drive
- name: Upload public folder to Google Drive
uses: intersecato/[email protected]
id: driveUpload
with:
target: public
credentials: secrets.<YOUR_DRIVE_CREDENTIALS>
folder: <YOUR_DRIVE_FOLDER_ID>
# Send Telegram message
- name: Send link to file
uses: appleboy/telegram-action@master
with:
to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }}
message: File uploaded to ${{ steps.driveUpload.outputs.link }}
This is a little bit more complex workflow example. This is actually a simplified version of the current workflow that I use in my unity projects to test, compile, and upload several platform builds at a time.
name: Dev build
on:
push: { branches: [develop] }
env:
UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
jobs:
buildAndTestForSomePlatforms:
name: Build for ${{ matrix.targetPlatform }} on version ${{ matrix.unityVersion }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
projectPath:
- test-project
unityVersion:
- 2019.3.14f1
targetPlatform:
- StandaloneOSX
- StandaloneWindows64
- StandaloneLinux64
steps:
# Checkout
- name: Checkout repository
uses: actions/checkout@v2
with:
lfs: true
# Cache
- uses: actions/[email protected]
with:
path: ${{ matrix.projectPath }}/Library
key: Library-${{ matrix.projectPath }}-${{ matrix.targetPlatform }}
restore-keys: |
Library-${{ matrix.projectPath }}-
Library-
# Test
- name: Run tests
uses: webbertakken/[email protected]
id: testRunner
with:
projectPath: ${{ matrix.projectPath }}
unityVersion: ${{ matrix.unityVersion }}
# Upload test results
- uses: actions/upload-artifact@v1
with:
name: Test results (all modes)
path: ${{ steps.testRunner.outputs.artifactsPath }}
# Build
- name: Build projects
uses: webbertakken/[email protected]
with:
projectPath: ${{ matrix.projectPath }}
unityVersion: ${{ matrix.unityVersion }}
targetPlatform: ${{ matrix.targetPlatform }}
buildName: ${{ secrets.APP_NAME }}
# Upload to Drive
- name: Upload build to Google Drive
uses: intersecato/[email protected]
with:
target: build
name: ${{ matrix.targetPlatform }}
credentials: ${{ secrets.DRIVE_CREDENTIALS }}
folder: ${{ secrets.DRIVE_FOLDER }}