https://github.com/hummusonrails/dev-posts-to-jekyll-markdown-action

GitHub Action to get newest DEV.to posts and convert to Jekyll markdown
https://github.com/hummusonrails/dev-posts-to-jekyll-markdown-action

blog dev devto github-actions hacktoberfest jekyll jekyll-markdown markdown

Last synced: 2 months ago
JSON representation

GitHub Action to get newest DEV.to posts and convert to Jekyll markdown

• Host: GitHub
• URL: https://github.com/hummusonrails/dev-posts-to-jekyll-markdown-action
• Owner: hummusonrails
• License: mit
• Created: 2020-02-12T16:15:03.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-05T07:14:35.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T22:54:23.855Z (8 months ago)
• Topics: blog, dev, devto, github-actions, hacktoberfest, jekyll, jekyll-markdown, markdown
• Language: JavaScript
• Homepage:
• Size: 409 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Convert DEV Posts to Jekyll Markdown Post GitHub Action

This action does the following:

* Search for a DEV contributor's latest blog posts using the DEV API

* Check to see if the newest DEV post is newer than the latest post in the Jekyll repository

* If the DEV post is newer than the newest repository post, raise a pull request in the repository with the DEV post converted to Jekyll markdown.

## Installation

To use this action in your Jekyll blog post repository, you need to do the following:

* Add a `.github/workflows` folder to your repository

* Create a `dev-to-jekyll.yml` file in the folder

* Add the following inside the file:

```

name: Convert DEV Posts to Jekyll Markdown

on:

 schedule:

     # At midnight twice a week on Monday and Thursday

    - cron:  '0 0 * * 1,4'

jobs:

  dev-to-jekyll:

    runs-on: ubuntu-latest

    steps:

    - name: dev-to-jekyll

      uses: bencgreenberg/dev-posts-to-jekyll-markdown-action@main

    env:

      GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

      DEV_API_KEY: "${{ secrets.DEV_API_KEY }}"

      NUM_OF_POSTS: "${{ secrets.NUM_OF_POSTS }}"

```

* Add the following [secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to your repository:

    * `DEV_API_KEY` *(Your API key from DEV.to)*

    * `REPO_OWNER` *(The owner of the repository, i.e. "jane")*

    * `REPO` *(Your repository name, i.e. "sample-repository")*

* Every Monday and Thursday at midnight this action will run. If there are any new DEV posts during that time, the action will create the relevant pull requests for you to review.

## Contributing

We welcome contributions! Please follow the [GitHub flow](https://guides.github.com/introduction/flow/) when introducing changes. If it recommended to open an Issue first, so it can be discussed and collaborated on before you start working on what you plan.

## LICENSE

This project is under the [MIT License](LICENSE.txt).