Github Action To Upload Artifacts to Google Drive Using A Google Drive API.

Watch our comprehensive tutorial on how to use this action:

This tutorial covers:

• Setting up the Google Drive API
• Creating and configuring a service account
• Using the action in your GitHub workflow
• Handling different upload scenarios

steps:
    - uses: actions/checkout@v4.1.1

    - name: Upload Artifacts TO Google Drive
      uses: Jumbo810/Upload_Github_Artifacts_TO_GDrive@v2.3.1
      with:
        target: <LOCAL_PATH_TO_YOUR_FILE>
        credentials: ${{ secrets.YOUR_SERVICE_ACCOUNT_CREDENTIALS }}
        parent_folder_id: <YOUR_DRIVE_FOLDER_ID>

• Upload files from your GitHub workflow to Google Drive
• Support for uploading multiple files using glob patterns
• Create nested folders automatically
• Option to override existing files
• Support for custom file naming
• Secure handling of Google Drive credentials
• Multiple file handling strategies (delete, update, or add new)

Before using this action, you need to set up the Google Drive API:

1. Go to the Google Cloud Console

2. Create a new project or select an existing one

3. Enable the Google Drive API

4. Create a service account

5. Create a key for the service account (JSON format)

6. Base64 encode the JSON key file:

   Windows (PowerShell):

   [Convert]::ToBase64String([System.IO.File]::ReadAllBytes("path\to\your-key-file.json"))

   macOS:

   base64 --input ~/Downloads/your-key-file.json

   linux:

   base64 path/to/your-key-file.json

7. Store the encoded key in a GitHub Secret

8. Create a folder in Google Drive where you want to upload artifacts, then set the share permission to "Editor" so the Github Action can upload the files to this folder using service account.

9. Copy the ID of your Google Drive folder from the browser URL. When you're viewing your folder in Google Drive, the folder ID is the long string of characters that appears after 'folders/' in the URL. For example, in the URL 'https://drive.google.com/drive/folders/1AbCdEfGhIjKlMnOpQrStUvWxYz12345', the folder ID is '1AbCdEfGhIjKlMnOpQrStUvWxYz12345'. You'll need this ID for the parent_folder_id parameter in your GitHub workflow.

For a visual guide, please refer to our video tutorial.

steps:
    - uses: actions/checkout@v4.1.1

    - name: Upload Multiple Files TO Google Drive
      uses: Jumbo810/Upload_Github_Artifacts_TO_GDrive@v2.3.1
      with:
        target: "dist/*.zip"
        credentials: ${{ secrets.YOUR_SERVICE_ACCOUNT_CREDENTIALS }}
        parent_folder_id: <YOUR_DRIVE_FOLDER_ID>

steps:
    - uses: actions/checkout@v4.1.1

    - name: Upload to Nested Folder with Custom Name
      uses: Jumbo810/Upload_Github_Artifacts_TO_GDrive@v2.3.1
      with:
        target: build/app.jar
        name: application-${{ github.sha }}.jar
        credentials: ${{ secrets.YOUR_SERVICE_ACCOUNT_CREDENTIALS }}
        parent_folder_id: <YOUR_DRIVE_FOLDER_ID>
        child_folder: releases/${{ github.ref_name }}

steps:
    - uses: actions/checkout@v4.1.1

    - name: Upload with Override
      uses: Jumbo810/Upload_Github_Artifacts_TO_GDrive@v2.3.1
      with:
        target: build/latest.zip
        credentials: ${{ secrets.YOUR_SERVICE_ACCOUNT_CREDENTIALS }}
        parent_folder_id: <YOUR_DRIVE_FOLDER_ID>
        override: true

steps:
    - uses: actions/checkout@v4.1.1

    - name: Upload with Custom Ownership
      uses: Jumbo810/Upload_Github_Artifacts_TO_GDrive@v2.3.1
      with:
        target: build/report.pdf
        credentials: ${{ secrets.YOUR_SERVICE_ACCOUNT_CREDENTIALS }}
        parent_folder_id: <YOUR_DRIVE_FOLDER_ID>
        owner: user@yourdomain.com

steps:
    - uses: actions/checkout@v4.1.1

    - name: Upload with Update-in-Place Strategy
      uses: Jumbo810/Upload_Github_Artifacts_TO_GDrive@v2.3.1
      with:
        target: build/latest.zip
        credentials: ${{ secrets.YOUR_SERVICE_ACCOUNT_CREDENTIALS }}
        parent_folder_id: <YOUR_DRIVE_FOLDER_ID>
        replace_mode: update_in_place

The action provides the following outputs that can be used in subsequent steps:

• file_id: The ID of the uploaded file
• file_name: The name of the uploaded file
• web_view_link: The web view link to access the file in Google Drive
• upload_count: The number of files uploaded (will be "1")

• file_ids: Comma-separated list of file IDs
• file_names: Comma-separated list of file names
• web_view_links: Comma-separated list of web view links
• upload_count: The number of files uploaded

- name: Upload to Google Drive
  id: upload
  uses: Jumbo810/Upload_Github_Artifacts_TO_GDrive@v2.3.1
  with:
    credentials: ${{ secrets.GOOGLE_CREDENTIALS }}
    parent_folder_id: ${{ secrets.GOOGLE_PARENT_FOLDER_ID }}
    target: "./build/my-app.zip"
    
- name: Use the upload outputs
  run: |
    echo "File ID: ${{ steps.upload.outputs.file_id }}"
    echo "File Name: ${{ steps.upload.outputs.file_name }}"
    echo "Web View Link: ${{ steps.upload.outputs.web_view_link }}"

1. Authentication Errors

   • Ensure your credentials are correctly base64 encoded
   • Check that the service account has access to the specified folder

2. File Not Found

   • Verify that the target path is correct
   • Check if the file exists in your workflow environment

3. Permission Denied

   • Ensure the service account has write access to the folder
   • Check if domain-wide delegation is properly set up when using the owner parameter

4. Multiple Files with Same Name

   • Use the override parameter to replace existing files
   • Use unique filenames or add timestamps to avoid conflicts

This project uses automated workflows to simplify the release process:

1. Automatic Dist Updates: After successful CI runs on the master branch, the dist/index.js file is automatically updated with the latest build artifact.

2. Creating a Release:

   • Update the version in package.json and CHANGELOG.md
   • Merge changes to the master branch
   • Create and push a new tag: git tag v2.3.1 && git push origin v2.3.1
   • The release workflow will automatically create a GitHub release

For security best practices when using this action, please refer to our Security Policy.

This project is licensed under the MIT License - see the LICENSE file for details.