Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

README with Todoist

Actions
Updates README with your Todoist stats
v1.0.0-beta
Pre-release
Star (3)

Tags

 (1)

Todoist Stats

Update your Todoist Stats


Work in Progress

Setup

Prep work

  1. You'll need a Todoist API Token. You can get that from here
    • if you're new to Todoist, then you can refer here.
  2. 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>
  3. You need to update the README file(README.md) with some tags. You can refer here for updating it.

Update your README

Add tags to your README.md like this:

# Todoist Stats

Hello, my name is Siddharth. I am a Todoist **<td-karma-level></td-karma-level>**

Available tags:

Coming soon

New to Todoist

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.

  • Create a Todoist account from here
  • Get your Todoist API Key from your here

Repository Workflow

Please follow the steps below:

  1. Go to your <username>/<username>/actions, hit New workflow, set up a workflow yourself, delete all the default content github made for you.
  2. 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: SiddharthShyniben/[email protected]
        with:
          TODOIST_API_KEY: ${{ secrets.TODOIST_API_KEY }}
          PREMIUM: "" # If you are premium, set it to true, else leave as is

Don't forget to change the PREMIUM property to true if you are premium

  1. 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 the USERNAME with your own username.
  2. 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.
  3. Add a comment to your README.md like this:
# Todoist Stats

In Todoist, I am a **<td-karma-level></td-karma-level>** ...
  1. Go to Workflows menu (mentioned in step 1), click Todoist Readme, and click Run workflow.
  2. Go to your profile page. you will be able to see it.

License

CC0

To the extent possible under law, Siddharth Shyniben has waived all copyright and related or neighboring rights to this work.

README with Todoist is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Updates README with your Todoist stats
v1.0.0-beta
Pre-release

Tags

 (1)

README with Todoist is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.