Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbta/github-asana-action
GitHub Action to integrate Asana and GitHub
https://github.com/mbta/github-asana-action
Last synced: about 1 month ago
JSON representation
GitHub Action to integrate Asana and GitHub
- Host: GitHub
- URL: https://github.com/mbta/github-asana-action
- Owner: mbta
- License: mit
- Created: 2022-06-16T20:31:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T18:02:10.000Z (8 months ago)
- Last Synced: 2024-05-03T17:20:52.494Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.6 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `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](https://developers.asana.com/docs/#authentication-basics).
### `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:
```yaml
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:
```yaml
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](https://github.com/asdf-vm/asdf-nodejs) is one option
### [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable)
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](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#commit-tag-and-push-your-action-to-github) 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
git push --follow-tags
```
After merge to main and pushing the tag, your release should be available as `v`