https://github.com/ganeshkumartk/dev.to-md

Search for new DEV blog posts and raise a PR with the post converted to Jekyll Markdown Post
https://github.com/ganeshkumartk/dev.to-md

action blog devto github-actions markdown markdown-converter

Last synced: about 6 hours ago
JSON representation

Search for new DEV blog posts and raise a PR with the post converted to Jekyll Markdown Post

• Host: GitHub
• URL: https://github.com/ganeshkumartk/dev.to-md
• Owner: ganeshkumartk
• License: apache-2.0
• Created: 2020-03-14T14:43:42.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T10:01:02.000Z (almost 2 years ago)
• Last Synced: 2024-10-30T04:49:55.466Z (17 days ago)
• Topics: action, blog, devto, github-actions, markdown, markdown-converter
• Language: JavaScript
• Homepage:
• Size: 787 KB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dev.to Posts -> .md

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 and replace the last repository post with the DEV post.

This action has a user defined environment variable of `NUM_OF_POSTS`, which is equal to an integer value of the number of blog posts you wish to live in your Jekyll blog post repository. For example, if you define `6` then the action will check that the latest DEV blog post is not newer than the top 6 blog posts in your repository. If it is, then it will remove the oldest one of the 6 and add the newest DEV blog post as markdown to your Jekyll site in the form of a pull request.

## 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-md.yml` file in the folder

* Add the following inside the file:

```

name: Convert DEV Posts to Markdown

on:

 schedule:

     # At midnight twice a week on Monday and Fridayday

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

jobs:

  dev-to-md:

    runs-on: ubuntu-latest

    steps:

    - name: dev-to-md

      uses: coderganesh/Dev.to-md@master

    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)*

    * `NUM_OF_POSTS` *(The maximum number of posts)*

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

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

* Every Monday and Friday 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 [Apache 2.0 License](LICENSE).