Feature: add original estimate option to issue creation by rodcloutier · Pull Request #748 · ankitpokhrel/jira-cli

rodcloutier · 2024-07-11T19:42:15Z

This PR intends to add the possibility of specifying the original estimate when creating an issue.

New option is called -e, --original-estimate
Will set the { timetracking: { originalEstimate: "" } value in the payload.

❯ ./jira issue create --help
Create an issue in a given project with minimal information.

USAGE
  jira issue create [flags]

FLAGS
  -t, --type string                   Issue type
  -P, --parent string                 Parent issue key can be used to attach epic to an issue.
                                      And, this field is mandatory when creating a sub-task.
  -s, --summary string                Issue summary or title
  -b, --body string                   Issue description
  -y, --priority string               Issue priority
  -r, --reporter string               Issue reporter (username, email or display name)
  -a, --assignee string               Issue assignee (username, email or display name)
  -l, --label stringArray             Issue labels
  -C, --component stringArray         Issue components
      --fix-version stringArray       Release info (fixVersions)
      --affects-version stringArray   Release info (affectsVersions)
  -e, --original-estimate string      Issue Original estimate
      --custom stringToString         Set custom fields (default [])
  -T, --template string               Path to a file to read body/description from
      --web                           Open in web browser after successful creation
      --no-input                      Disable prompt for non-required fields
  -h, --help                          help for create

INHERITED FLAGS
  -c, --config string    Config file (default is /Users/rcloutier/.config/.jira/.config.yml)
      --debug            Turn on debug output
  -p, --project string   Jira project to look into (defaults to /Users/rcloutier/.config/.jira/.config.yml)

EXAMPLES
  $ jira issue create

  # Create issue in the configured project
  $ jira issue create -tBug -s"New Bug" -yHigh -lbug -lurgent -b"Bug description"

  # Create issue in another project
  $ jira issue create -pPRJ -tBug -yHigh -s"New Bug" -b$'Bug description\n\nSome more text'

  # Create issue and set custom fields
  # See https://github.com/ankitpokhrel/jira-cli/discussions/346
  $ jira issue create -tStory -s"Issue with custom fields" --custom story-points=3

  # Load description from template file
  $ jira issue create --template /path/to/template.tmpl

  # Get description from standard input
  $ jira issue create --template -

  # Or, use pipe to read input directly from standard input
  $ echo "Description from stdin" | jira issue create -s"Summary" -tTask

  # For issue description, the flag --body/-b takes precedence over the --template flag
  # The example below will add "Body from flag" as an issue description
  $ jira issue create -tTask -sSummary -b"Body from flag" --template /path/to/template.tpl

LEARN MORE
  Use 'jira <command> <subcommand> --help' for more information about a command.
  Read the doc or get help at https://github.com/ankitpokhrel/jira-cli

ankitpokhrel

This works great 🎉

Thank you @rodcloutier

The recent changes in PR ankitpokhrel#748 caused issues with jira-cli when used with Jira Enterprise On-Prem (now referred to as DataCenter). All requests started failing with the following error message: ``` Error: - timetracking: Field 'timetracking' cannot be set. It is not on the appropriate screen, or unknown. ``` The issue arises because, even if the `--original-estimate` option is not specified, the timetracking field is included in the JSON query. This PR addresses the issue by ensuring that the timetracking field is only included in the JSON query if the `--original-estimate` option is set. I have tested the fix, and all tests are passing. Please review the changes and let me know if there are any concerns.

* fix: regression introduced by new OriginalEstimate attribute The recent changes in PR #748 caused issues with jira-cli when used with Jira Enterprise On-Prem (now referred to as DataCenter). All requests started failing with the following error message: ``` Error: - timetracking: Field 'timetracking' cannot be set. It is not on the appropriate screen, or unknown. ``` The issue arises because, even if the `--original-estimate` option is not specified, the timetracking field is included in the JSON query. This PR addresses the issue by ensuring that the timetracking field is only included in the JSON query if the `--original-estimate` option is set. I have tested the fix, and all tests are passing. Please review the changes and let me know if there are any concerns. * Fix test that don't include timetracking cli option

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [ankitpokhrel/jira-cli](https://github.com/ankitpokhrel/jira-cli) | patch | `v1.5.1` -> `v1.5.2` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>ankitpokhrel/jira-cli (ankitpokhrel/jira-cli)</summary> ### [`v1.5.2`](https://github.com/ankitpokhrel/jira-cli/releases/tag/v1.5.2) [Compare Source](ankitpokhrel/jira-cli@v1.5.1...v1.5.2) #### What's Changed - feat: issue view: Raw response option by [@mpalahuta](https://github.com/mpalahuta) in ankitpokhrel/jira-cli#720 - feat: Add original estimate option to issue creation by [@rodcloutier](https://github.com/rodcloutier) in ankitpokhrel/jira-cli#748 - feat: Allow updating parent on edit by [@ankitpokhrel](https://github.com/ankitpokhrel) in ankitpokhrel/jira-cli#765 - feat: Add cli method for close sprint with supporting jira client … by [@cworsnup13](https://github.com/cworsnup13) in ankitpokhrel/jira-cli#756 ankitpokhrel/jira-cli#778 - fix: Epic description overridden in no-input mode by [@ankitpokhrel](https://github.com/ankitpokhrel) in ankitpokhrel/jira-cli#728 - fix: Regression introduced by new OriginalEstimate attribute by [@fabio42](https://github.com/fabio42) in ankitpokhrel/jira-cli#767 - fix: Consider Windows Terminal as non-dumb terminal by [@beatbrot](https://github.com/beatbrot) in ankitpokhrel/jira-cli#706 - fix: Improve zsh autocomplete directions by [@omair-inam](https://github.com/omair-inam) in ankitpokhrel/jira-cli#739 #### New Contributors - [@mpalahuta](https://github.com/mpalahuta) made their first contribution in ankitpokhrel/jira-cli#720 - [@omair-inam](https://github.com/omair-inam) made their first contribution in ankitpokhrel/jira-cli#739 - [@rodcloutier](https://github.com/rodcloutier) made their first contribution in ankitpokhrel/jira-cli#748 - [@fabio42](https://github.com/fabio42) made their first contribution in ankitpokhrel/jira-cli#767 - [@cworsnup13](https://github.com/cworsnup13) made their first contribution in ankitpokhrel/jira-cli#756 **Full Changelog**: ankitpokhrel/jira-cli@v1.5.1...v1.5.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Feature: add original estimate option to issue creation

eb18ce5

ankitpokhrel approved these changes Jul 27, 2024

View reviewed changes

ankitpokhrel merged commit 527d3cd into ankitpokhrel:main Jul 27, 2024

fabio42 mentioned this pull request Aug 26, 2024

fix: regression introduced by new OriginalEstimate attribute #767

Merged

wbh1 mentioned this pull request Aug 27, 2024

fix: timetracking field always marshalled #768

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature: add original estimate option to issue creation#748

Feature: add original estimate option to issue creation#748
ankitpokhrel merged 1 commit intoankitpokhrel:mainfrom
petalmd:feature/add-original-estimate-to-issue-creation

rodcloutier commented Jul 11, 2024

Uh oh!

ankitpokhrel left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

rodcloutier commented Jul 11, 2024

Uh oh!

ankitpokhrel left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants