GithubHelp home page GithubHelp logo

erikoui / krypto Goto Github PK

View Code? Open in Web Editor NEW

This project forked from antoniouaa/krypto

0.0 1.0 0.0 538 KB

A python tool that creates issues in your repos based on TODO comments in your code

License: MIT License

Python 97.32% Dockerfile 2.44% Shell 0.24%

krypto's Introduction

Krypto

tests black Code style: black Coverage Status

A neat little sidekick python script to create issues on your repo based on comments left in the code on your behalf

Convert todo comments in your code
# TODO: Make config file
# Sometimes you might wanna have TODOs in your tests.
# Right now krypto will completely ignore any file with the
# substring "test" in the path. I would want to be able to
# configure this behaviour.

to GitHub issues on the repository you're working on!

Sample issue on Github

Env Variables

For this to work you need to have a github token in your environment variables. To acquire a token navigate to Developer Settings and generate one.

With the token in hand, simply,

export TOKEN_GITHUB = token_here

or

$env:TOKEN_GITHUB = token_here

If you want the token to persist across sessions you need to add it to your .bashrc or $PROFILE.

Usage

Write a TODO

First, create a TODO in the form of a block comment. The TODO must contain a title. Body and labels are optional.

Examples:

  • Title only, no body or labels

    # TODO: This is a title
  • Title, body, no labels

    # TODO: This is a title
    # This is in the TODO body
  • Title, body and labels

    # TODO[Enhancement]: This is a title
    # This is in the TODO body
  • Multiple labels

    # TODO[Enhancement, Bug, Documentation]: This is a title

Valid separators include , / # ~ \

To run

Pass the directory to look in for TODOs.

krypto <path-to-dir>

Krypto does not look in tests/ at the moment.


GitHub Action

This action runs Krypto on your code and creates issues on the repo on your behalf

Inputs

dir

Required The path to the directory to scan for TODOs

Env

TOKEN_GITHUB

Required A personal access token for github to use to authenticate the creation of issues on your repository

Example usage

uses: antoniouaa/krypto@v1
with:
  dir: "."
env:
  TOKEN_GITHUB: ${{ secrets.GITHUB_TOKEN }}

Inspired by tsoding/snitch

krypto's People

Contributors

antoniouaa avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.