Skip to content

Latest commit

 

History

History
145 lines (101 loc) · 4.37 KB

README.md

File metadata and controls

145 lines (101 loc) · 4.37 KB
Raw

issuefer

CI

What it does

This program finds all TODOs in the source code and reports them as issues to GitHub or GitLab.

  1. Write a TODO somewhere in your source code in the form
// TODO: Some test
  1. Run issuefer -r which will present you with the opportunity to automatically create a issue out of the found TODOs.
  2. Issuefer will add the assigned issue number to the TODO and will automatically create a commit (it will not automatically push, you have to do that yourself).

How to build it

Build it in the standard Rust way with

cargo build --release

The resulting binary can be found at target/release/issuefer.

Configuration

From config file

Issuefer supports reading its configuration from <CONFIG_DIR>/issuefer (preferred) or <HOME_DIR>/.issuefer.

<HOME_DIR> is defined as

Platform Value Example
Linux $HOME /home/alice
macOS $HOME /Users/Alice
Windows {FOLDERID_Profile} C:\Users\Alice

<CONFIG_DIR> is defined as

Platform Value Example
Linux $XDG_CONFIG_HOME or $HOME/.config /home/alice/.config
macOS $HOME/Library/Preferences /Users/Alice/Library/Preferences
Windows {FOLDERID_RoamingAppData} C:\Users\Alice\AppData\Roaming

The config is a simple ini file in the format

[github.com]
token = github_token

[gitlab.com]
token = gitlab_token

[some.gitlab.host]
token = other_gitlab_token

[some.other.gitlab.host]
token = yet_another_gitlab_token

In addition you can tell issuefer to ignore file by extension in the following way:

[general]
ignored_extensions = md;png;exe

From environment

If no config file can be found, issuefer tries to find its config from environment variables.

GitHub token

Issuefer needs a GitHub token to work. You can find out how to create here.

It will read the token from the environment variable GITHUB_TOKEN, so you can either run issuefer with

export GITHUB_TOKEN=YOUR_TOKEN /path/to/issuefer

or the easier way (maybe not the safest) is to add it to your ~/.profile:

echo 'export GITHUB_TOKEN="YOUR_TOKEN"' >> ~/.profile

You have to login again to apply that change.

GitLab token

Issuefer needs a GitLab token when working with a GitLab repo. Create it on your GitLab page and set it with

export GITLAB_TOKEN=YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN /path/to/issuefer

or with

echo 'export GITLAB_TOKEN="YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN"' >> ~/.profile

to make it permanent, as it is done for GitHub. The syntax is host:token and they are separated by ;. If no host part is specified, it is assumed to be a gitlab.com token.

How to set environment variables on Windows with PowerShell

If you want to use issuefer on Windows and you want to use environment variables here is an example for GITLAB_TOKEN in PowerShell.

To set the environment variable use

$env:GITLAB_TOKEN = 'YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN'

or to persist it to your user profile use

[System.Environment]::SetEnvironmentVariable('GITLAB_TOKEN', 'YOUR_HOST:YOUR_TOKEN;ANOTHER_HOST:ANOTHER_TOKEN;GITLAB_COM_TOKEN', [System.EnvironmentVariableTarget]::User)

Run it

When typing

./issuefer

it will report the untracked TODOs and TODOs where the corresponding issue has been closed.

To actually report new TODOs type

./issuefer -r

and to cleanup the sources from TODOs which correspond to already closed issues type

./issuefer -c

Supported TODO formats

Currently issuefer only supports TODOs in the format

// TODO: some text

and they have the stand in a separate line (with optional whitespaces/tabs in front).

In the future we will hopefully support also C like comments (/* */) and multi line TODOs (which will then add the additional lines as body to the issue).