Overview
The “Convert DEV Posts to Jekyll Markdown Post GitHub Action” is a tool that automates the process of converting blog posts from DEV to Jekyll markdown and raising pull requests in a Jekyll blog post repository. It uses the DEV API to search for a DEV contributor’s latest blog posts and compares them to the latest post in the Jekyll repository. If a newer post is found, it creates a pull request with the DEV post converted to Jekyll markdown.
Features
- Automated Conversion: This action automatically converts DEV blog posts to Jekyll markdown.
- API Integration: The action utilizes the DEV API to fetch the latest blog posts.
- Comparison and Pull Requests: It compares the DEV posts with the latest post in the Jekyll repository and creates pull requests for the new posts.
Installation
To use this action in your Jekyll blog post repository, follow these steps:
- Add a
.github/workflowsfolder to your repository. - Create a
dev-to-jekyll.ymlfile inside theworkflowsfolder. - Copy and paste the following code inside the
dev-to-jekyll.ymlfile:on: schedule: - cron: '0 0 * * 1,4' jobs: convert: runs-on: ubuntu-latest steps: - name: Check out repository uses: actions/checkout@v2 - name: Convert DEV Posts to Jekyll Markdown uses: username/repo@v1 with: dev-api-key: ${{/* secrets.DEV_API_KEY */}} - Add the following secrets to your repository:
DEV_API_KEY: Your API key from DEV.to.REPO_OWNER: The owner of the repository (e.g., “jane”).REPO: Your repository name (e.g., “sample-repository”).
Once these steps are completed, the action will run every Monday and Thursday at midnight. If there are any new DEV posts during that time, it will automatically create the relevant pull requests in your Jekyll blog post repository for you to review.
Summary
The “Convert DEV Posts to Jekyll Markdown Post GitHub Action” is a powerful tool for developers using Jekyll and DEV.to for their blog posts. It automates the process of converting and syncing blog posts between the two platforms, saving time and effort. By seamlessly integrating with the DEV API and Jekyll repository, it ensures that the latest posts are always up-to-date and easily accessible in the Jekyll format. With its user-friendly installation process and regular schedule, it provides a convenient solution for developers to manage their blog posts efficiently.