< Changes
Fedora-Change-Wrangler
The Motivation for this Tool is to easy the Current Change Process procedure,reduce Manual Work involved for both the Contributors and the Change-Wrangler(FPgm). The tool makes it easy by covering all the functionality required for the process of moving forward proposals
Summary
A Cli Tool Written in Python that interacts with Taiga,Pagure and Bugzilla.Functionality includes Promoting,announcing,submitting,accepting and updating the changes across the three platforms and over mailing list.
Owner
- Name: Manas Mangaonkar
- Email: manasmangaonkar@gmail.com || pac23@fedoraproject.org
Current status
- Targeted release: Fedora 32
- Last updated: 2019-05-15
- Tracker bug: <will be assigned by the Wrangler>
- Release notes tracker: <will be assigned by the Wrangler>
Detailed Description
As Part of GSoC 2019 the fedora-change-wrangler tool will be developed to smooth out the workflow,reduce Manual Work involved for both the Contributors and the Change-Wrangler(FPgm). The tool makes it easy by covering all the functionality required for the process of moving forward proposals.
The tool will be developed using Python 3.6+ and will interact with Taiga/Pagure/Bugzilla via their API and the Mailing List via SMTP. The General Workflow would be : 1. Change Owner opens an issue and fills in the fields. When they are ready to submit the Change proposal, they set the status to "Ready for Wrangler". 2. The Change Wrangler (FPgM) reviews the proposal. If it is incomplete, they set the status back to "New" and inform the Change Owner of what's needed. If it is ready to process, then...
Functionality covered 1. Promote
- The issue will be promoted to a user story in taiga,copies the contents of the custom fields from the issue to the user story. Closes the issue.
2. Announce
- The tool would have the functionality to enable announcing the change proposal to devel and devel-announce lists using smtp. It will also automatically change the story status to announced.
3. fesco-submit
- Allowing creation of a new issue in the FESco Pagure repo directly from the command line.
4. Accept
- Once the changes are accepted the change-wrangler can create a tracking bug in Bugzilla along with release notes on Pagure.THe status of the user story is updated to accepted aswell.
5. Update
- Status can be changed to testable if BZ is "Modified" and to Complete is BZ is "ON_QA"
6. Creation of Report
- The user can create a report to provide quick view of changes and their status. It can be in wiki or Html form.
Techstack:
- Python3.6+
- SMTP
- Taiga/Pagure/Bugzilla API's
- Nano/Gedit/Vi ( Inbuilt support to edit text)
- Kerberos(For authentication)
The current sample arg created looks like this [ change-tool convert --taiga <issue no> <issue no> ] . The advantage of this the Manager would be able to specify unlimited no of issues to change at once in a single command using the issue no in taiga to convert to user story.
Benefit to Fedora
Will Make change process easy for everyone involved.
Scope
- Proposal owners:
I will be working with the Change-Wrangler(Ben Cotton) throughout the summer to create this tool from scratch.
- Other developers: N/A (not a System Wide Change)
- Release engineering: #Releng issue number (no release engineering impact is expected)
- Policies and guidelines: N/A (not a System Wide Change)
- Trademark approval: N/A (not needed for this Change)
Upgrade/compatibility impact
Other than the regular updation of the change-wrangler package nothing else will be required.
N/A (not a System Wide Change)
How To Test
N/A (not a System Wide Change)
User Experience
No visible Impact is expected.
Dependencies
Python3.6,SMTPLIB and requests no other dependencies. No Completion roadblocks expected as almost all of the dependencies are very well maintained or have alternatives.
N/A (not a System Wide Change)
Contingency Plan
- Contingency mechanism: (What to do? Who will do it?) N/A (not a System Wide Change)
- Contingency deadline: N/A (not a System Wide Change)
- Blocks release? N/A (not a System Wide Change), Yes/No
- Blocks product? product
Enough buffer time has been allocated to complete this during the GSoC period.
Documentation
Detailed documentation will be done once the coding part of the tool is done.Documentation has been scheduled for july 25th and after.
N/A (not a System Wide Change)