GitHub Actions Workflow to save your articles on GitHub

Anmol Baranwal

Completed work

Software Engineer

GitHub

Postman

TypeScript

GitHub Actions Workflow to save articles

The problem is that there is no way to save the articles or reading list from dev.to as a backup and this project solves that.

I've used Forem v1 APIs for building DevtoGithub. You can read about it on GitHub Actions Marketplace.

Use cases

The workflow can save your articles in a different markdown file.

The details like tags, cover image, URL and published time are shown in a proper format.

You can also create a table of contents in the readme to view and visit each of your articles in the saved repository.

You can save your reading lists with specified structures and URLs for easy access.

You can display the reading time for each article in the reading list.

You can customize the directory in which you want to save the articles and the reading list.

You can synchronize your reading list from DEV. For instance, if you remove any article from the reading list on DEV, then it will also be removed from the reading list in the readme.

All articles and the reading list will be fetched regardless of the total number.

If you update an article on DEV, it will be automatically updated here the next time the workflow runs.

You get a total of 10+ configuration options.

Getting Started

You just need to do a few steps to create a repository and generate an API token from DEV. Don't worry, you can use this complete guide, which has clear instructions and image examples for each step.

This is an example of sample workflow file.

name: DevtoGitHub

on:
  schedule:
    - cron: "0 0 * * *" # Run daily, adjust as needed
  # The lines below will allow you to manually run the workflow with each commit
  workflow_dispatch:
  push:
    branches: ["main"]

jobs:
  save-articles:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v3

      - name: Run DevtoGitHub
        uses: Anmol-Baranwal/DevtoGitHub@v1
        with:
          devApiKey: ${{ secrets.DEV_TOKEN }}
          saveArticles: true # default
          outputDir: "articles" # this will save the articles in "articles" directory
          saveArticlesReadme: true # this will create a table of content for easy navigation