Remove the Jira integration

Open
#469 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
backend

Research direction

Start with openedx_webhooks/tasks/jira_work.py and the jira: label handling in pr_tracking.py, then trace the Jira helpers in info.py, auth.py and utils.py. Check tests/fake_jira.py and the Jira test cases before deleting anything. Done means the Jira code, templates, setting and docs are gone and the test suite passes. This is a maintainer decision still open for discussion, so confirm the removal plan before starting.

Written by the indexing model from the issue text.

Description

The bot can create and update Jira issues for pull requests: a jira:<nick> label on a PR looks up a server by nickname in the private jira-info registry, creates an issue there using the repo's .github/jira-mapping.yaml, and records the issue id in the bot's comment. That path hasn't been used in some time, and it's a fair amount of code and config to keep working for nothing: openedx_webhooks/tasks/jira_work.py, the Jira steps in pr_tracking.py, the Jira helpers in info.py, bot_comments.py, auth.py and utils.py, the JIRA_INFO_FILE setting, the no_jira_* and jira_issue_comment templates, the Jira output of the rescan views, and tests/fake_jira.py with everything that uses it.

I think we should remove it rather than keep maintaining it. Rough plan:

  • Stop acting on jira: labels and drop the Jira steps from PrTrackingFixer.
  • Delete jira_work.py, the Jira session in auth.py, jira_paginated_get and get_jira_issue in utils.py, and the Jira templates.
  • Remove the JIRA_INFO_FILE setting from the Heroku apps and the docs (docs/install.rst, docs/details.rst, README.rst).
  • Delete tests/fake_jira.py and the Jira cases in the tests.
  • Close #189, #192 and #285 as won't do.

Wanted to call this out before doing it in-case anyone is still relying on it.

Dominant language
Python
Stars
13
Forks
22
Avg merge
1d 6h
Merged PRs (30d)
6

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openedx/openedx-webhooks

All issues in openedx/openedx-webhooks

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.