⚡️📌 Update your Todoist Stats ✅
- You'll need a Todoist API Token. You can get that from here
- if you're new to Todoist, then you can refer here.
- You need to save the Todoist API Token in the repository secrets. You can find that in the Settings of your Repository. Be sure to save those as the following.
TODOIST_API_KEY = <your todoist API token>
- You need to update the README file(README.md) with 2 comments. You can refer here for updating it.
Add a comment to your README.md
like this:
# Todoist Stats
<!-- TODO-IST:START -->
<!-- TODO-IST:END -->
These lines will be our entry-points for the todoist stats.
Todoist gives you the confidence that everything’s organized and accounted for, so you can make progress on the things that are important to you.
Please follow the steps below:
- Go to your
<username>/<username>/actions
, hitNew workflow
,set up a workflow yourself
, delete all the default content github made for you. - Copy the following code and paste it to your new workflow you created at step 1:
name: Todoist Readme
on:
workflow_dispatch:
schedule:
# Runs every minute
- cron: "* * * * *"
jobs:
update-readme:
name: Update todoist stats
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: abhisheknaiidu/todoist-readme@master
with:
TODOIST_API_KEY: ${{ secrets.TODOIST_API_KEY }}
PREMIUM: ""
- Go to your repo secrets by hitting
Settings => Secrets
tab in your profile repo. You can also enter the url https://github.com/USERNAME/USERNAME/settings/secrets . Please replace theUSERNAME
with your own username. - Create a new
Secret
.Name
:TODOIST_API_KEY
,Value
: Paste the Todoist API Token here. If you don't know what is the token, please go to here to find your API Key there. - Add a comment to your
README.md
like this:
# Todoist Stats
<!-- TODO-IST:START -->
<!-- TODO-IST:END -->
- Go to Workflows menu (mentioned in step 1), click
Todoist Readme
, and clickRun workflow
. - Go to your profile page. you will be able to see it.
Please follow the steps below:
- Go to your
<username>/<username>/actions
, hitNew workflow
,set up a workflow yourself
, delete all the default content github made for you. - Copy the following code and paste it to your new workflow you created at step 1:
name: Todoist Readme
on:
workflow_dispatch:
schedule:
# Runs every minute
- cron: "* * * * *"
jobs:
update-readme:
name: Update todoist stats
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: abhisheknaiidu/todoist-readme@master
with:
TODOIST_API_KEY: ${{ secrets.TODOIST_API_KEY }}
PREMIUM: true
- Remaining Steps will be same as Non-Premium Users.
To the extent possible under law, Abhishek Naidu has waived all copyright and related or neighboring rights to this work.
Inspired by yg/todoist-box
Inspired by gautamkrishnar/blog-post-workflow