README.md

Today's Weather

Hanoi, Vietnam - 19/09/2024

Moderate rain

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	Clear	Clear	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy light rain	Sunny	Patchy light rain	Patchy rain nearby	Patchy rain nearby	Partly Cloudy	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Patchy rain nearby	Cloudy	Patchy rain nearby	Patchy rain nearby
Temperature	25.7 °C	25.3 °C	24.9 °C	24.6 °C	24.5 °C	24.3 °C	24 °C	24.9 °C	26.9 °C	29.3 °C	30.9 °C	31.9 °C	34.3 °C	31 °C	28.7 °C	27.2 °C	26.7 °C	26.4 °C	26.2 °C	26.1 °C	26 °C	25.9 °C	25.8 °C	25.6 °C
Wind	8.3 kph	9.4 kph	10.8 kph	10.8 kph	12.6 kph	12.6 kph	11.2 kph	10.8 kph	11.9 kph	15.1 kph	19.4 kph	20.9 kph	17.3 kph	13.7 kph	13.3 kph	16.9 kph	12.2 kph	9.4 kph	4.7 kph	4.3 kph	5 kph	7.2 kph	7.6 kph	6.8 kph

Weather For Next 3 days

Date	19/09/2024	20/09/2024	21/09/2024
Weather
Condition	Moderate rain	Moderate rain	Heavy rain
Temperature	24 - 32.5 °C	24.6 - 28.7 °C	24 - 33 °C
Wind	20.9 kph	11.2 kph	16.6 kph

Updated at: 2024-09-19T05:29:30Z

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: huantt/weather-forecast@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 github-actions@github.com
                  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/huantt/weather-forecast

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