Releases: Balastrong/chess-stats-action
Releases · Balastrong/chess-stats-action
Version 2.0.1
What's Changed
- feat: Show time class by @iib0011 in #11
- Handle null values in stats by @hackmajoris in #12
- Fix: add optional typing by @Balastrong in #13
- One less dependency! by @FelipeIzolan in #14
- fix: username is now lowercase as the api fails otherwise by @Balastrong in #15
- test: reorganize tests and add coverage by @Balastrong in #16
- feat: add User-Agent header to get access after the new chess.com api policies by @Balastrong in #21
New Contributors
- @hackmajoris made their first contribution in #12
- @FelipeIzolan made their first contribution in #14
Full Changelog: v2...v2.0.1
Version v2 is out!
What's Changed
It is now possible to add a table with stats from your current and best score in rapid, blitz and bullet games.
- feat: show stats by @iib0011 in #7
- Improved docs and actions by @Balastrong in #9
- Refactor and getting ready for release v2 by @Balastrong in #10
New Contributors
Full Changelog: v1.0.3...v2
Version 1.0.3
- Replaced the coloring (didn't work) with icons on win - tie - loss
- Added a new (optional) flag to show the final position on a FEN visualizer
Version 1.0.2
Fix on naming - more news coming soon!
First release!
First release!
Automatically add and keep up to date your latest games from chess.com.
White ⚪ | Black ⚫ | Result 🏆 | Date 📅 |
---|---|---|---|
Hikaru | TigrVShlyape | win | 27/7/2022 |
Hikaru | Salem-AR | stalemate | 27/7/2022 |
mbojan | Hikaru | win | 27/7/2022 |
Hikaru | honestgames | win | 27/7/2022 |
Russian_berezka | Hikaru | win | 27/7/2022 |
Hikaru | bipe137 | win | 27/7/2022 |
Witik | Hikaru | resigned | 26/7/2022 |
Hikaru | Manukyan_Artak | win | 26/7/2022 |
K_A_S_T_O_R | Hikaru | resigned | 26/7/2022 |
Hikaru | jinbojinbo | win | 26/7/2022 |
Usage
Add these two placeholders somewhere in your README.md
, they will get replaced by the action.
<!--START_SECTION:chessStats-->
<!--END_SECTION:chessStats-->
Create a GitHub Action in your repository, you can call it chess-stats-action.yml
.
name: Chess Stats Action
on:
schedule:
- cron: '0 0 * * *' # Runs at 00:00 UTC every day
workflow_dispatch:
jobs:
update-readme:
name: Update readme with your chess stats and games
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: Balastrong/chess-stats-action@master
with:
CHESS_USERNAME: <Your chess.com Username>
Configuration
There are a few configuration options you can use in your GitHub Action.
Parameter | Description | Default | Required |
---|---|---|---|
CHESS_USERNAME | Your chess.com username | hikaru | Yes |
COMMIT_MSG | Commit message used while committing to the repo | Update README with your chess games | No |
GAMES_SIZE | How many games to load | 10 | No |
SHOW_DATE | Toggle the Date column | true | No |
Contributing
There are many possible ways to expand the functionalities or improve the current logic. Feel free to have a look at the open issues or create a new one youself if something is missing.
PRs are also welcome!