github.com/coding-to-music/github-actions-cron-readme-weather-api

Today's Weather

Boston, United States of America - 15/09/2023

Overcast

Hour	00:00	01:00	02:00	03:00	04:00	05:00	06:00	07:00	08:00	09:00	10:00	11:00	12:00	13:00	14:00	15:00	16:00	17:00	18:00	19:00	20:00	21:00	22:00	23:00
Weather
Condition	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Overcast	Cloudy	Partly cloudy	Sunny	Sunny	Partly cloudy	Cloudy	Overcast	Overcast	Partly cloudy
Temperature	16.9 °C	16.7 °C	16.5 °C	16.3 °C	16.1 °C	15.6 °C	15.6 °C	15.6 °C	15.8 °C	16.3 °C	16.4 °C	17.3 °C	17.7 °C	18.3 °C	19.4 °C	20.8 °C	22.5 °C	23 °C	22.5 °C	20.6 °C	18.9 °C	18.4 °C	18 °C	18.9 °C
Wind	24.8 kph	25.2 kph	25.9 kph	26.6 kph	26.3 kph	26.3 kph	22.3 kph	19.4 kph	18.7 kph	20.5 kph	23.8 kph	31.3 kph	33.1 kph	30.2 kph	27 kph	24.8 kph	25.9 kph	24.1 kph	23.4 kph	22.7 kph	20.5 kph	19.1 kph	18 kph	24.1 kph

Weather For Next 7 days

Date	15/09/2023	16/09/2023	17/09/2023	18/09/2023	19/09/2023	20/09/2023	21/09/2023
Weather
Condition	Overcast	Sunny	Heavy rain	Moderate rain	Sunny	Sunny	Sunny
Temperature	15.6 - 23 °C	14 - 26.4 °C	15.9 - 17.7 °C	13.5 - 22.7 °C	10.7 - 20.9 °C	11.2 - 19.8 °C	11.7 - 19.1 °C
Wind	33.1 kph	17.6 kph	14 kph	23 kph	14 kph	11.2 kph	11.9 kph

Updated at: 2023-09-16T04:08:43Z

GitHub Actions: Embed up-to-date Weather in your README

View

You can easily embed tables in your README.md using GitHub Actions by following these simple steps:

Step 1: In your repository, create a file named README.md.template.

Step 2: Write anything you want within the README.md.template file.

Step 3: Embed one of the following entities within your README.md.template:

• Today's Weather Table:

{{ template "hourly-table" $.TodayWeather.HourlyWeathers }}

• Daily Weather Table:

{{ template "daily-table" .Weathers }}

• Updated at:

{{ formatTime .UpdatedAt }}

If you are familiar with Go templates, you have access to the root variable, which includes the following fields:

• Weathers: An array of daily Weather. You can view the Weather struct definition in model/weather.go.
• UpdatedAt: This field contains the timestamp in the format of time.Date.

Step 4: Register Github Action

• Create a file .github/workflows/update-weather.yml in your repository.

name: "Cronjob"
on:
schedule:
  - cron: "15 * * * *"

jobs:
  update-weather:
    permissions: write-all
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Generate README
        uses: coding-to-music/github-actions-cron-readme-weather-api@v1.0.5
        with:
          city: HaNoi
          days: 7
          weather-api-key: ${{ secrets.WEATHER_API_KEY }}
          template-file: "README.md.template"
          out-file: "README.md"
      - name: Commit
        run: |
          if git diff --exit-code; then
            echo "No changes to commit."
            exit 0
          else
            git config user.name github-actions
            git config user.email [e-mail]
            git add .
            git commit -m "update"
            git push origin main
          fi

• Update some variable in this file:
  • city: The city that you want to forecast weather
  • days: number of forecast days
  • template-file: Path to the above template file. Eg. template/README.md.template
  • out-file: your README.md file name
  • weather-api-key:
    • Register free API key in https://weatherapi.com
    • Setup secrets with name WEATHER_API_KEY in Your repo > settings > Secrets and variables > Actions > New repository secret

Step 5: Commit your change, then Github actions will run as your specificed cron to update Weather into your README.md file

Usage

View

Install

go install https://github.com/coding-to-music/github-actions-cron-readme-weather-api

Run

Usage:
weather-forecast update-weather [flags]

Flags:
--city string              City
--days int                 Days of forecast (default 7)
-h, --help                     help for update-weather
-o, --out-file string          Output file path
-f, --template-file string     Readme template file path
-k, --weather-api-key string   weatherapi.com API key

Sample

weather-forecast update-weather \
--days=7 \
--weather-api-key="$WEATHER_API_KEY" \
--template-file='template/README.md.template' \
--city=HaNoi \
--out-file='README.md'

Docker

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