to markdown

This is a small project that I started because I wanted to have my weekly chart on my GitHub profile. I used GitHub Actions because they can be scheduled with cron jobs and you won't need to pass any sensitive information to modify the file.

? Example output, automatically updated every day

??‍? What you'll need

  • A file.
  • API key
    • Fill this form to instantly get one. Requires a account.
  • Set up a GitHub Secret called LASTFM_API_KEY with the value given by
  • Also set up a LASTFM_USER GitHub Secret with the user you'll get the weekly charts for.
  • Add a <!-- lastfm --> tag in your file, with two blank lines below it. The album covers will be placed here.


To use this release, add a lastfm.yml workflow file to the .github/workflows folder in your repository with the following code:

name: lastfm-to-markdown

    - cron: '2 0 * * *'

    runs-on: ubuntu-latest
      - uses: actions/[email protected]
      - name: lastfm to markdown
        uses: melipass/[email protected]
          LASTFM_API_KEY: ${{ secrets.LASTFM_API_KEY }}
          LASTFM_USER: ${{ secrets.LASTFM_USER }}
#         IMAGE_COUNT: 6 # Optional. Defaults to 10. Feel free to remove this line if you want.
      - name: commit changes
        continue-on-error: true
        run: |
          git config --local "[email protected]"
          git config --local "GitHub Action"
          git add -A
          git commit -m "Updated's weekly chart" -a

      - name: push changes
        continue-on-error: true
        uses: ad-m/[email protected]
          github_token: ${{ secrets.GITHUB_TOKEN }}\
          branch: main

The cron job is scheduled to run once a day because's API updates weekly chart data daily at 00:00, it's useless to make more than 1 request per day because you'll get the same information back every time. You can manually run the workflow in case's API was down at the time, going to the Actions tab in your repository.

? To do

  • Allow users to choose the image size for the album covers.
  • Feel free to open an issue or send a pull request for anything you believe would be useful.