https://github.com/biglocalnews/upload-files

Upload comma-delimited files to biglocalnews.org in your GitHub Action
https://github.com/biglocalnews/upload-files

action actions archiving csv data data-journalism github-actions journalism news

Last synced: 29 days ago
JSON representation

Upload comma-delimited files to biglocalnews.org in your GitHub Action

• Host: GitHub
• URL: https://github.com/biglocalnews/upload-files
• Owner: biglocalnews
• License: apache-2.0
• Created: 2022-02-01T00:40:46.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-06T15:10:22.000Z (9 months ago)
• Last Synced: 2024-05-07T18:01:16.390Z (6 months ago)
• Topics: action, actions, archiving, csv, data, data-journalism, github-actions, journalism, news
• Language: Python
• Homepage: https://github.com/marketplace/actions/upload-data-to-biglocalnews-org
• Size: 40 KB
• Stars: 1
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Upload comma-delimited files to [biglocalnews.org](https://biglocalnews.org) in your GitHub Action

## Inputs

* `api-key`: Your biglocalnews.org API token.

* `project-id`: The identifier of the biglocalnews.org project where the files will be uploaded.

* `path`: The file or folder path inside the action's filesystem to upload.

## Usage

Upload a single CSV file.

```yaml

name: Example action

jobs:

  job:

    name: Upload file

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Upload file to biglocalnews.org

        uses: biglocalnews/upload-files@v2

        with:

          api-key: ${{ secrets.BLN_API_KEY }}

          project-id: ${{ secrets.BLN_PROJECT_ID }}

          path: your-file.csv

```

Upload a directory of CSV files.

```yaml

name: Example action

jobs:

  job:

    name: Upload directory

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Upload folder to biglocalnews.org

        uses: biglocalnews/upload-files@v2

        with:

          api-key: ${{ secrets.BLN_API_KEY }}

          project-id: ${{ secrets.BLN_PROJECT_ID }}

          path: your-folder/

```

## About

The project is sponsored by [Big Local News](https://biglocalnews.org/#/about), a program at Stanford University that collects data for impactful journalism. The code is maintained by [Ben Welsh](https://palewi.re/who-is-ben-welsh/), a visiting data journalist from the Los Angeles Times.