A github action to help with CRUD operations on google sheets.

• gsheet.action
  • Getting Started
    • Prerequisites
    • Setup in github action workflow (v2)
  • Supported commands
    • addSpreadsheet
    • getSpreadsheet
    • addWorksheet
    • getWorksheet
    • removeWorksheet
    • updateData
    • appendData
    • getData
  • Build with
  • Contributing
  • Versioning
  • License

Secrets required as environment variables

• GSHEET_CLIENT_EMAIL (email of the service account that has permission to access the spreadsheet)
• GSHEET_PRIVATE_KEY (private key of the service account that has permission to access the spreadsheet)

name: gsheet.action test
on: push

jobs:
  fetch:
    runs-on: ubuntu-latest
    steps:
      - id: 'update_worksheet'
        uses: jroehl/gsheet.action@v1.0.0 # you can specify '@release' to always have the latest changes
        with:
          spreadsheetId: <spreadsheetId>
          commands: | # list of commands, specified as a valid JSON string
            [
              { "command": "addWorksheet", "args": { "worksheetTitle": "<worksheetTitle>" }},
              { "command": "updateData", "args": { "data": [["A1", "A2", "A3"]] }},
              { "command": "getData", "args": { "range": "'<worksheetTitle>'!A2:B3" } }
            ]
        env:
          GSHEET_CLIENT_EMAIL: ${{ secrets.GSHEET_CLIENT_EMAIL }}
          GSHEET_PRIVATE_KEY: ${{ secrets.GSHEET_PRIVATE_KEY }}
      - name: dump results
        env:
          #  the output of the action can be found in ${{ steps.update_worksheet.outputs.results }}
          RESULTS: ${{ steps.update_worksheet.outputs.results }}
        run: echo "$RESULTS" | jq

See ./github/workflows/e2e.yml for another example.

Add a spreadsheet with the specified title to the spreadsheet

• args
  • spreadsheetTitle:string - The title of the worksheet

Get a spreadsheet with the specified title

• args
  • [spreadsheetId]?:string - The id of the spreadsheet (needed if no previous command set the spreadsheetId globally)

Add a worksheet with the specified title to the spreadsheet

• args
  • worksheetTitle:string - The title of the worksheet (needed if no previous command set the worksheetTitle globally)
  • [spreadsheetId]?:string - The id of the spreadsheet (needed if no previous command set the spreadsheetId globally)

Get a worksheet with the specified title

• args
  • worksheetTitle:string - The title of the worksheet (needed if no previous command set the worksheetTitle globally)
  • [spreadsheetId]?:string - The id of the spreadsheet (needed if no previous command set the spreadsheetId globally)

Remove an existing worksheet with the specified title

• args
  • worksheetTitle:string - The title of the worksheet (needed if no previous command set the worksheetTitle globally)
  • [spreadsheetId]?:string - The id of the spreadsheet (needed if no previous command set the spreadsheetId globally)

Updates cells with the specified data (at the specified range)

• args
  • data:string - The data to be used as a JSON string - nested array [["1", "2", "3"]]
  • [spreadsheetId]?:string - The id of the spreadsheet (needed if no previous command set the spreadsheetId globally)
  • [minRow=1]?:number - Starting row of the operation
  • [minCol=1]?:number - Starting row of the operation
  • [range]?:string - Range in a1 notation to be used for the operation
  • [valueInputOption=RAW]?:string - The input value to be used
  • [worksheetTitle]?:string - The title of the worksheet (needed if no previous command set the worksheetTitle globally)

Append cells with the specified data after the last row (in starting col)

• args
  • data:string - The data to be used as a JSON string - nested array [["1", "2", "3"]]
  • [spreadsheetId]?:string - The id of the spreadsheet (needed if no previous command set the spreadsheetId globally)
  • [minCol=1]?:number - Starting row of the operation
  • [range]?:string - Range in a1 notation to be used for the operation
  • [valueInputOption=RAW]?:string - The input value to be used
  • [worksheetTitle]?:string - The title of the worksheet (needed if no previous command set the worksheetTitle globally)

Get cell data (within specified range)

• args
  • [spreadsheetId]?:string - The id of the spreadsheet (needed if no previous command set the spreadsheetId globally)
  • [minRow=1]?:number - Starting row of the operation
  • [minCol=1]?:number - Starting row of the operation
  • [maxRow]?:number - Last row of the operation
  • [maxCol]?:number - Last row of the operation
  • [range]?:string - Range in a1 notation to be used for the operation
  • [hasHeaderRow]?:boolean - If the first row should be treated as header row
  • [worksheetTitle]?:string - The title of the worksheet (needed if no previous command set the worksheetTitle globally)

• google-sheet-cli - The node module used for manipulating the google sheet
• semantic-release - for releasing new versions
• typescript

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

We use SemVer for versioning. For the versions available, see the tags on this repository.

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