The world’s leading publication for data science, AI, and ML professionals.
Create a Simple Continuous Integration (CI) for Medium RSS Feed in GitHub Profile README
GitHub is actually a platform where anyone who interests in Programming can share their codes to collaborate with others. Many open-source companies are using GitHub as their collaboration management system where developers across the world can contribute to project development. Those are Google, Facebook, Microsoft, Twitter, LinkedIn, Netflix, PostgreSQL, Apache, etc. They are using git to boost their project performance.
However, many of us as the programmer or data scientist often use GitHub as the portfolio which means contains all of our previous projects. So, people who want to hire us as their talent can easily look at our projects. That’s the point where GitHub becomes not only for versioning and collaboration tools but also a portfolio. We need to design our GitHub as pretty as possible.
On July, 17th 2020, GitHub just released a new feature: GitHub profile README! It helps us make our GitHub looks impressive and professional. Through this article, I would like to give you an example of how to add our Medium RSS feed on GitHub profile README. So, keep reading and keep focus!
Getting Started with Git and GitHub: A Complete Tutorial for Beginner
As mentioned in the previous section, we will add the Medium RSS feed in GitHub profile README but what is the RSS feed? RSS which is an abbreviation for RDF Site Summary or Really Simple Syndication is a summary of the web information. The RSS feed is created using XML in a standardized format.
Medium provides RSS feeds for user profiles, publications, and topic pages. Using an RSS feed URL, we can:
We are able to look at our Medium RSS feed using a custom URL as follows. Fill the [username] with our own username and look at the result as our Medium RSS feed. Read the detailed explanation of the Medium RSS feed HERE.
It shows the top ten latest articles that are written by us. It will let our readers know our up-to-date articles. That is the mechanism of the RSS feed.
Finally, we are in the important section of this article. We will create an impressive GitHub profile README as our portfolio resume. It will allow our followers to know better about us regarding our projects, contributions on open source projects in GitHub, our activity in other platforms such as Medium, WordPress, etc. It sounds great! Those will be covered in our portfolio that contains information as follows.
The following picture is an example of Medium and WordPress’s latest article created by me in my GitHub profile README. That’s wonderful, right? Wanna try? Let’s go!
First, to create a GitHub profile README, create files and a custom directory in GitHub that is displayed on the picture.
Edit our README.md file using the following markdown template to create a GitHub profile README. You are able to modify the script as you like your preferences. However, there are several notes in order to modify the README.md script as follows.
For the Latest Medium Story section, you can replace the MEDIUM-STORY-LIST with your preference but important to remember that it will connect to the workflow
For the section of GitHub Stat, it is as simple as replace my username (audhiaprilliant) with your own. It will show our GitHub statistics about the total of stars from our repo, total commits, total pull request, total issues, number of contributions to the open-source project, and the GitHub grade. Furthermore, the GitHub Stats has two settings: to show the icons and to show the image border which helps us to custom the image.
Read more about GitHub stats HERE.
Next, we need to interact with GitHub action in order to update the Medium RSS feed in GitHub. Previously, create a YAML file inside the .github/workflow named medium-story-workflow.yml or with your own filename. Further, this YAML file is created to define our workflow configuration.
Read more about GitHub workflow HERE.
Notes related to the Medium YAML file
Replace the feed_list with your Medium RSS feed
The YAML file will automatically check the Medium RSS feed and update the README.md file if there are an up-to-date article
After making a YAML file, go over the GitHub Actions menu and we will find out the list of our workflow, namely Latest Medium story workflow. In order to run this workflow, left-click on Latest Medium story workflow and select the Run workflow menu on the right corner and left-click the green button.
Slowly, the workflow will in the queue stage and a run stage. The output will display whether our workflow is done successfully or not. The green checklist indicates that the workflow is successful.
Please direct to our GitHub profile README page and look at the Medium section. It should show the list of our latest Medium articles based on the Medium RSS feed.
Unluckily, sometimes there will be an error regarding our workflow. Don’t be worry! Further, GitHub will send us an email as a notification so we can rerun the workflow manually.
Lastly, I want to thank Jesse for the tutorial he gave via 𝚌𝚘𝚍𝚎𝚂𝚃𝙰𝙲𝙺𝚛 YouTube channel. For a detailed explanation, you can easily click the following video created by Jesse. Thank you!
GitHub is such a wonderful platform, not only for collaboration and versioning but also to keep our projects. Luckily, on July, 17th 2020, GitHub just released a new feature: GitHub profile README and it adds the new function of GitHub, portfolio. Using GitHub profile README, we can describe our projects, tools, articles, etc over the world and let people connect with us.
[1] Anonim. Using RSS feeds of profiles and publications, 2020. https://help.medium.com/.
[2] GitHub Team. GitHub Actions, 2020. https://docs.github.com/en/.
Written By
Topics:
Share this article:
Step-by-step code guide to building a Convolutional Neural Network
Here’s how to use Autoencoders to detect signals with anomalies in a few lines of…
Solving the resource constrained project scheduling problem (RCPSP) with D-Wave’s hybrid constrained quadratic model (CQM)
An illustrated guide on essential machine learning concepts
Derivation and practical examples of this powerful concept
Columns on TDS are carefully curated collections of posts on a particular idea or category…
With demos, our new solution, and a video
Your home for data science and Al. The world’s leading publication for data science, data analytics, data engineering, machine learning, and artificial intelligence professionals.

source