https://github.com/biglocalnews/warn-github-flow

GitHub Action workflow for automating a WARN Act notice ETL pipeline
https://github.com/biglocalnews/warn-github-flow

actions data-journalism git-scraper journalism labor news python

Last synced: 7 days ago
JSON representation

GitHub Action workflow for automating a WARN Act notice ETL pipeline

• Host: GitHub
• URL: https://github.com/biglocalnews/warn-github-flow
• Owner: biglocalnews
• License: apache-2.0
• Created: 2022-02-18T21:46:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T14:35:19.000Z (17 days ago)
• Last Synced: 2024-10-29T17:41:44.336Z (17 days ago)
• Topics: actions, data-journalism, git-scraper, journalism, labor, news, python
• Language: Makefile
• Homepage: https://biglocalnews.org/content/tools/layoff-watch.html
• Size: 685 MB
• Stars: 5
• Watchers: 7
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A GitHub Action workflow for automating a WARN Act notice ETL pipeline.

## How it works

The [extract, transform and load](https://github.com/biglocalnews/warn-github-flow/actions/workflows/etl.yml) Action runs every few hours. It does the following:

- 🔪 Gather raw WARN Act notices from all of our sources with [warn-scraper](https://github.com/biglocalnews/warn-scraper)

- 🪢 Consolidate the raw files into a single, standardized dataset with [warn-transformer](https://github.com/biglocalnews/warn-transformer)

- ⏫ Upload the files to our archive on [biglocalnews.org](https://biglocalnews.org) with [upload-files](https://github.com/biglocalnews/upload-files)

- 📟 Send Slack and Teams alerts

```mermaid

flowchart TB

    subgraph Extract

    A[Scrape sources] --> B[Commit to source-specific branches]

    B --> C[Upload raw files to biglocalnews.org]

    end

    subgraph Transform

    subgraph Consolidate

    D[Download raw files from biglocalnews.org] --> E[Merge into a single file]

    end

    subgraph Integrate

        F[Reconcile latest data with current database]

        F --> G[Identify any additions and amendments]

    end

    end

    subgraph Load

    H[Commit transformed files to `transformer` branch] --> I[Upload transformed files to biglocalnews.org]

    end

    subgraph Alert

    subgraph Members

    L[Forward new notices via Slack and Teams bots]

    end

    subgraph Administrators

    J[Post status report to Big Local News Slack]

    end

    end

    Extract --> Transform

    Consolidate --> Integrate

    Transform --> Load

    Load --> Alert

```

## 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.