Coder Social home page Coder Social logo

github-asana-action's Introduction

github-asana-action

This action integrates Asana with GitHub.

Prerequisites

  • Asana account personal access token, with permissions to write to the relevant project(s)
  • Task URL provided in the PR description, appropriately formatted (see below)

Inputs

asana-pat

Required Your personal access token for Asana, you can create one here.

trigger-phrase

Required Prefix before the task e.g. Asana Task: https://app.asana.com/1/2/3/. For special characters in the trigger phrase refer to the examples.

target-section

Optional If provided, attempts to move the task into the given section for each of the projects the task is associated with.

task-comment

Optional If any comment is provided, the action will add a comment to the specified Asana task with the text and also append the pull request URL.

mark-complete

Optional If set to true, the action will mark the specified Asana task as complete.

Sample PR Description

Asana Task: https://app.asana.com/0/1/2

Examples

Without special characters:

uses: mbta/[email protected]
with:
    asana-pat: "Your PAT"
    task-comment: "View Pull Request Here: "
    trigger-phrase: "Asana Task:"
    target-section: "Done"
    mark-complete: true

With special characters:

uses: mbta/[email protected]
with:
    asana-pat: "Your PAT"
    task-comment: "View Pull Request Here: "
    trigger-phrase: "\\*\\*Asana Task:\\*\\*"
    target-section: "Done"

Development

Requirements

node

Installing asdf with asdf-nodejs plugin is one option

After installing node, run npm install -g yarn

Finally, run yarn in the base of the repository to fetch the dependencies defined in package.json/yarn.lock.

Formatting

You can format index.js by running yarn format

Building a release

We use vercel/ncc to build this action into a distribution. See the Github Actions Docs for more information.

On your branch,

  • Bump the version in package.json
  • Run yarn build
  • Commit the resulting files in dist/

After merging to main,

  • Add a tag on the main branch
git tag -a -m "Adds support for link titles" v<version>
git push --follow-tags

After merge to main and pushing the tag, your release should be available as v<version>

github-asana-action's People

Contributors

firestack avatar gshkolnik avatar iamalisajid avatar meagharty avatar srehaider avatar viggyfresh avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  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.