DEV Community

Creating Dynamic README.md File

Jack on September 10, 2023

This is my Github Profile. The specific thing here is that the weather is updated every 6 hours automatically. (I know that embedding weather in ...

Read full post

Md. Fahim Bin Amin • Sep 13 '23

Loved it! I would like to make a video about it. I hope that is okay.

Jack • Sep 14 '23

I have recently developed another GitHub Action for updating your dev.to articles on your GitHub profile.
dev.to/jacktt/update-your-devto-ar...

I think you can use it in your video.

Md. Fahim Bin Amin • Sep 14 '23

Awesome. I guess it would be better if I create separate video for that.

Jack • Sep 13 '23

Absolutely, you're welcome to use it as video content. Please share your video in the comments once you've completed it. I'm looking forward to seeing it!

Md. Fahim Bin Amin • Sep 13 '23

Sure!

Md. Fahim Bin Amin • Sep 14 '23

The weather-forecast action was not working till now. I was trying for several hours back then. It seems now it is online. I will try to make the video within tonight.

Jack • Sep 14 '23

Could you share me your repo or action log?

Md. Fahim Bin Amin • Sep 14 '23

Here it is: github.com/FahimFBA/test/actions
I made it private but making it public for you to check. The latest build also failed suddenly.

Jack • Sep 14 '23

I found the problem. Because nothing has changed, the commit command returns an error.

Please update the run block to:

          if git diff --exit-code; then
            echo "No changes to commit."
            exit 0
          else
            git config user.name github-actions
            git config user.email github-actions@github.com
            git add .
            git commit -m "update"
            git push origin main
          fi

I updated the docs.

Md. Fahim Bin Amin • Sep 14 '23

Let's see whether it works then. If it works, then I am going to create the video.

tq-bit • Sep 12 '23

This is pretty cool. You could even combine it with the Github API to get a breakdown on all of your used languages over your repositories or perhaps your LOC count

Akash Dev • Sep 13 '23

Thank you I'am going to try this out

Leo • Sep 15 '23

nice article 🌟

Leo • Sep 15 '23

Just a little comment, I faced this problem: level=ERROR msg="html/template:article:36:12: no such template \"article-table\"". Seem we should use huantt/article-listing@v1.1.0 instead of huantt/article-listing@v1.0.0

Jack • Sep 15 '23

You're right.
I will update the docs and this article.

Thank you.

Mitchell Mutandah • Nov 25 '23

Great post ❤️. I'm going to try it!

Hudson Atwell • Sep 28 '23

Thanks for the tutorial 🙌

Rizmy Abdulla 🎖️ • Sep 10 '23

Nice post ❤️

Jack • Sep 10 '23

Thank you. I hope it's useful for you.

Jeremy Meiss • Sep 16 '23

When using your

{{ formatTime .UpdatedAt }}

it errors out in GitHub Actions:

level=ERROR msg="template: article:6:14: executing \"article\" at <.UpdatedAt>: invalid value; expected time.Time"

but when I update it to the way you're using it

{{ formatTime .Time }}

it works just fine. Probably worth updating your post

Jack • Sep 16 '23

Which Action are you using?

Jeremy Meiss • Sep 17 '23 • Edited

I was using it with the Dev.to articles action

But also, thank you for these 2 posts. Great work!

Jack • Sep 17 '23

Time is variable in article action, CreatedAt is in weather

Salman • Sep 13 '23

my GitHub

Fady GA 😎 • Sep 11 '23

Didn't know that Github actions can be triggered with a cron expression! This is really a good post 👏

Md. Fahim Bin Amin • Sep 16 '23

This doesn't work anymore.

I have already tried to create the video 3 times, but each time had to delete the footage for that.

Jack • Sep 16 '23

Look at the error message: API key has been disabled

That means you have not configured the weather api key or your api key has been disabled.
Please login to weatherapi.com to check it.

Md. Fahim Bin Amin • Sep 16 '23

After trying to change and get new APIs, it seems that some of them work, but in most cases, those APIs are not working. It might be the case that some of their free APIs work great, or it might also be an issue as I needed to regenerate multiple APIs.
However, I don't think this is a good idea to create a video as the APIs are not consistent. Therefore, I am leaving the task.

However, please change the URL to weatherapi.com/ as the mentioned one doesn't work.

Nguyen Hoang • Sep 18 '23

I got this error "Warning: Unexpected input(s)" when running jobs
Warning: Unexpected input(s) 'city', 'days', 'weather-api-key', 'template-file', 'out-file', valid inputs are ['repository', 'ref', 'token', 'ssh-key', 'ssh-known-hosts', 'ssh-strict', 'persist-credentials', 'path', 'clean', 'sparse-checkout', 'sparse-checkout-cone-mode', 'fetch-depth', 'fetch-tags', 'show-progress', 'lfs', 'submodules', 'set-safe-directory', 'github-server-url']

Jack • Sep 18 '23

I visited your repository, and the error is "No matching location found." This means that your input city is invalid. I will try to help you search for your city, but it may not support your city. In this case, I may consider allowing you to input the location by latitude and longitude.

Nguyen Hoang • Sep 19 '23

Thanks so much, I can resolve the issue. Your function is great

Jatin Sharma • Sep 12 '23

GitHub Dynamic Readme is really good. But TBH I don't see any point showing the weather information in my README.

Jack • Sep 12 '23

It's made just for a demo :))

Jatin Sharma • Sep 12 '23

Oh, in that case it's fine. I was like why would anyone wants to see the weather info.

Alessandro Surace • Sep 21 '23

Very nice Jack! Thanks for sharing. I was trying to understand how do you say to build the docker Image before using it and cannot find it. Is it an implicit step?

Jack • Sep 21 '23

Sorry for missing it. I've updated the README.md.

docker build -t weather-forecast .

docker run --rm \
-v ./:/app/data \
weather-forecast \
--weather-api-key='XXXX' \
--city=HaNoi \
--out-file=data/README.md \
--template-file=data/README.md.template