Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Does this plugin synchronize the description field of a Jira ticket? #11

Open
passeris opened this issue Oct 18, 2022 · 2 comments
Open
Labels
question Further information is requested

Comments

@passeris
Copy link

I am trying to determine whether to use this plug-in. I see that it can create tickets in Jira, but what about synching changes between Jira and .rst? Is that even possible or is it a forward-engineering type of workflow?

The scenario is the following:

We have some requirements stored as Jira issues and would like to get access to them via sphinx. Will changing the text in a Jira issue in either location (sphinx rst file or Jira issue) update the data?

@Letme
Copy link
Member

Letme commented Oct 18, 2022

Currently, the plugin does not synchronize the changes - it has link to JIRA item, so you can trace the JIRA ticket, but there is no synchronization with update in rst, as honestly that would require pinging JIRA on each build and comparing the description which would then require a commit in git repository to update the .rst file (or issue Error when changes are there to get manual update). It would also mean that old releases would probably fail to rebuild as plugin would detect the difference and fail.

Maybe you can figure workflow that would suit you? Currently, we only use it to automatically create tasks and action items from meeting minutes in .rst when merge request is merged. That creates a link between meeting minutes and created jira ticket in rendered documentation.

@JasperCraeghs
Copy link
Member

JasperCraeghs commented Oct 20, 2022

Updates of the description from reST to Jira seems possible and relatively easy to implement:

  • If the description of the Jira ticket has not been changed by a user different from the Jira user that you use for this plugin, the changes from reST will be pushed.
  • If the description of the Jira ticket has been changed by a different user since the last time this plugin pushed a change, a warning will be reported.

What do you think about this?

Updates from Jira to reST also seem possible but which behavior do you desire?

@JasperCraeghs JasperCraeghs added the question Further information is requested label Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants