cjs77/crosscheck

Collaborate across tools

Collaborate across tools.

This project was replaced by a much more complete solution: http://unito.io

CrossCheck lets you use Asana as a frontend to manage work in other end systems. Currently only GitHub is supported, with some big limitations (see below).
Check out [The Big Picture] (https://github.com/marcboscher/crosscheck/wiki/The-Big-Picture).

Things you can already do

• View and edit GitHub issues from Asana, while remaining completely transparent to GitHub users.
• Manage issues in multiple GitHub repositories from a single Asana view.
• Add existing Asana task to a GitHub repo simply by assigning a project in Asana.
• Manage GitHub issues and non-GitHub tasks in the same view by assigning multiple Asana projects.
• Order github issues in Asana to prioritize them.
• Quickly add a bunch of issues using Asana's superfast UI.
• Easily add links to other Asana tasks using Asana's link auto-complete.

Limitations Roadmap

• Synchronize Comments done!
• Map GitHub labels to Asana tags
• Map GitHub milestones to Asana tags
• Map GitHub assignees to Asana assignees (only if assigned to you)
• Synchronize attachments
• Support Asana sections
• OAuth support

How It Works

To sync an Asana project with a GitHub repo, prefix the project name with #gh and specify the #gh.owner and #gh.repo in the project description. There's nothing to do on the GitHub side. Note the prefixes in the image below are outdated.

Getting Started

Setup the configuration (uses node-config) by creating a file config/local.yml within your working directory.

crosscheck:
    asana:
        apiKey: YOUR-ASANA-API-KEY
        
    github:
        # Recommended see https://help.github.com/articles/creating-an-access-token-for-command-line-use/
        personalAccessToken: YOUR-GITHUB-ACCESS-TOKEN
        # Alternative
        userName: YOUR-GITHUB-USER
        password: YOUR-GITHUB-PSW

Alternatively, you can also specify the keys using the environment variables:

• ASANA_API_KEY
• GITHUB_ACCESS_TOKEN
• GITHUB_USERNAME
• GITHUB_PASSWORD

Install with cli command

$ npm install -g crosscheck
$ crosscheck --help
$ crosscheck                # sync once
$ crosscheck -t 300         # sync every 5 minutes

Or install the module with: npm install crosscheck

var crosscheck = require('crosscheck');
crosscheck.sync();

Documentation

The API doc is not online yet, but you can generate it locally. Check out the project and cd into it:

$ npm install
$ grunt jsdoc
$ cd doc

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

MIT Copyright (c) 2014 Marc Boscher