danstis / ado-asana-sync Goto Github PK

WIP: A tool to sync tasks from Azure DevOps -> Asana

License: MIT License

Shell 0.08% Python 98.33% Dockerfile 1.59%

ado-asana-sync's Introduction

ado-asana-sync

This project aims to synchronize work items between Azure DevOps (ADO) and Asana. It's currently in development and not ready for use. Breaking changes will occur as needed.

How to use

Get the latest container image from the Github Container Registry.
Configure the environment variables with the relevant values:
- ADO_PAT - Your Personal Access Token for ADO to accesst the work items.
- ADO_URL - The full URL of your Azure DevOps instance.
- ASANA_TOKEN - Your Personal Access Token for Asana to access the work items.
- ASANA_WORKSPACE_NAME - Name of the Asana workspace to sync with.
- CLOSED_STATES - Comma separated list of states that will be considered closed.
- THREAD_COUNT - Number of projects to sync in parallel. Must be a positive integer.
- SLEEP_TIME - Duration in seconds to sleep between sync runs. Must be a positive integer.
- SYNCED_TAG_NAME - Name of the tag in Asana to append to all synced items. Must be a valid Asana tag name.
Run the container with the configured environment variables.
The application will start syncing work items between ADO and Asana based on the configured settings.

Development

Commit message style

This repo uses Conventional Commits to ensure the build numbering is generated correctly

Manual testing

To test the application manually, you can use the following steps:

Create new ADO work item and ensure it is synced to Asana.
Rename Asana task and ensure it is reverted back to the ADO name.
Rename ADO task and ensure it is synced to Asana.
Remove Synced tag from item in Asana and ensure it is replaced.
Delete synced tag from Asana workspace and from appdata.json file and ensure it is re-created and assigned to all synced tasks.
Mark Asana task as complete and ensure it is re-opened.
Mark ADO task as complete and ensure it is marked as complete in Asana.
Re-open ADO task and ensure it is re-opened in Asana.

Reference

ADO

Asana

ado-asana-sync's People

Contributors

Stargazers

Watchers

ado-asana-sync's Issues

Move Python version variable into GitHub repo variable

As a developer, I want the PYTHON_VERSION variable for the build and release pipelines moved into a repo variable, so I don't have to update the builds if I want to change the version.

Add new asana workspace variable to docker files

As a developer, I want the asana workspace variable added to the docker file, so the new config is done everywhere.

Sync items based on backlog level

As a user, I want multiple levels of backlog items to be enabled to sync to asana based on matching names, so items are synced to a known project in asana.

The mapping of items should follow the below rules:

Sync items on requirements backlog to the Asana project as tasks
Sync Task level items in ADO to asana as subtasks
Only sync items that are assigned to asana people
Add items to any other project in asana that matches a parent ado item name
Add items to any section in the select projects that match a parent item name

ADO	Asana
Project - Team	Project
Epic	(Additional Project if matching / Section if matching)
Feature	(Additional Project if matching / Section if matching)
Work Item	Task
Task	Subtask

[AAS-32] When running against an Asana workspace with many tasks an exception is raised

Investigate use of sync library - bergercookie/item_synchronizer: 🔄 Synchronize items from two different sources

https://github.com/bergercookie/item_synchronizer

Add PyPI details to the readme

As a user, I want the readme to link to the PyPI details of the package, so I know how to obtain the package.

Update release pipeline to publish package dist folder to the gtihub release

As a user, I want the release build to be attached to the GitHub release, so I can reference the built files for each version.

Publish builds to PyPI

As a user of the app, I want the binary version of the package published on PyPI, so I can easily find and install it.

Links

Replace the use of the Asana PAT with a proper app

As a developer, I want to swap out the use of an Asana PAT with a proper Asana app, so I don't have to create a sync user to own the PAT.

https://app.asana.com/0/my-apps

Removed items are re-opened on each sync

On every sync, ADO items that have been set to the removed state are re-opened in Asana.
They should be set to completed in Asana.

[AAS-9] Assign tasks to users in Asana when the ADO task is assigned, if there is a matching user

Move tag check and creation out of the project sync loop

As a user, I want the tag check and creation to happen once per sync round rather than once per project, so I don't have to wait for it many times during a single sync run.

Update docker image name to separate the sync process from other future containers

Create Asana subtasks for all child tasks/bugs within ADO

As a user, I want to have all child tasks of an ADO item to be synced as subtasks on the Asana item.

[AAS-34] Synced tasks contain an incorrect URL in the description

The synced tasks contain a link to the API workitem, not the regular web UI.

[AAS-23] Create docker container to run the app

[AAS-35] Do not sync tasks that are closed in ADO

As a user, I only want only tasks that are still open to be synced to Asana, so old closed tasks are not synced.

[AAS-16] Add DB to track item mapping

As a user, I want the synced tasks to track each other based on IDs, so I can rename tasks on either side without breaking the item relationship.

Allow sync from Asana tasks back to ADO

[AAS-11] Fix build pipeline for python

As a developer, I want the build pipeline to be updated to support the python version of the application, so I know that my changes are correct.

This pipeline should:

perform tagging of the commits
produce a release on github
add a github discussion item for the release

Update release versioning to match Python standards

As a developer, I want the builds to be versioned with Python compatible version number, so it aligns with the python standards.

[AAS-6] Sync work item title changes to the linked Asana task

As a user, I want the title of the synced tasks updated if the ADO task title is updated, so I don't get duplicate tasks if they are renamed.

Priority mapping

As a user, I want a mapping created that assigns priorities on the Asana work items based on the ADO priority, so the priority of the tasks align.

Add logging library rather than using print

Sync on a schedule

As a user, I want the sync process to happen continuously on a schedule, so I don't have to run it each time I want items synced or updated.

Change Asana Auth to use an Asana application rather than PAT

As a user, I want the sync to use an Asana app, so I don't have to create a user to perform the sync tasks.

[AAS-36] Release pipeline is failing with "Resource not accessible by integration"

Add option to force an item to sync based on tag

as a user, I want to have the option to add a tag in ADO to force an item to sync to Asana, so I can sync tasks that do not meet the normal sync rules.

[AAS-17] Limit sync of closed items for a set period

As a user, I want items to be able to re-open in Asana if they are re-opened on ADO, so I know to start working on them again in Asana.

Check if we can change out the work item API call to use this one

https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/work-items/list?view=azure-devops-rest-7.0&tabs=HTTP

Update build process to bump version in pyproject.toml file

As a developer, I want the build process to generate a binary version of the application with the correct version number based on the build and tags, so the version is integrated into the application.

The version in the default pyproject.toml file should be hardcoded to something that represents development (0.0.0-dev) and have the build process update the version before creating the built binary.

[AAS-33] Add tag to synced tasks to identify them

[AAS-13] Only sync assigned tasks

as a user, I want the sync process to only sync tasks that are assigned to a user that exists in Asana, so it does not sync unrelated tasks.

The user mapping between ADO and Asana should be created based on email if they match.

[AAS-10] Add Sonar cloud scanning

Update main entrypoint to use a better method to launch the app

As a developer, I want the entrypoint for the app to follow recommended practice, so it is obvious how the app is launched.

Sync tags on work items from ADO to Asana

New tasks do not get the Synced tag

When new tasks are created, they are not properly getting the synced tag in asana.

[AAS-38] Enable user matching on Display Name if email does not match

As a user, I want the sync app to handle the case where my email address is different in ADO vs Asana, so the tasks properly sync.

Move asana workspace name to an environment variable

As a developer, I want the Asana workspace name moved into the global config from the environment variables, so it is obvious there can be only one.

[AAS-1] Sync new items from ADO to Asana

As a user, I expect items created in ADO to have a matching item created in Asana.

Item types that are copied/synced should be configurable.

The service should create some binding key/id to enable future updates to the copied tasks.

[AAS-20] Add check list on PR template for linked labels

As a developer, I want to ensure all PRs have linked labels, so the release notes sections are properly populated.

[AAS-12] Update readme

As a developer, I want the readme updated to be accurate with the current Python version of the application, so others have the correct information.

add sonar cloud badge
remove go link

Fix issue with build pipeline for Mypi

ado_asana_sync/sync/sync.py: error: Source file found twice under different module names: "sync.sync" and "ado_asana_sync.sync.sync"
ado_asana_sync/sync/sync.py: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#mapping-file-paths-to-modules for more info
ado_asana_sync/sync/sync.py: note: Common resolutions include: a) adding `__init__.py` somewhere, b) using `--explicit-package-bases` or adjusting MYPYPATH
Found 1 error in 1 file (errors prevented further checking)