Make component field configurable #150

lgecse · 2023-08-03T11:37:17Z

Fixes #149

Dev notes:

added jira-components field to the config
added logic to fill the field of the Jira item when creating and updating
updated readme

codecov · 2023-08-03T11:39:20Z

Codecov Report

Merging #150 (f0f5cce) into main (0af3507) will not change coverage.
The diff coverage is n/a.

❗ Current head f0f5cce differs from pull request most recent head d60c7de. Consider uploading reports for the commit d60c7de to get more accurate results

@@          Coverage Diff          @@
##            main    #150   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files          1       1           
  Lines         67      67           
=====================================
  Misses        67      67

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

justaugustus

Great start, @lgecse!

The component field on Jira appears to support multiple components, so we'll want to support a slice of components vs a single component string in our config.

Additionally, have you considered what will happen in update scenarios (especially ones where the list of components that the user specifies in the config for this tool does not match the list of components already set on Jira)?

Given this tools' goal of being a one-way sync, we should:

get the current list of components for the issue
add the components specified in this config, but:
never remove components that are already set on the issue

(and have tests to ensure that behavior is adhered to)

README.md

internal/config/config.go

lgecse · 2023-08-03T16:02:59Z

@justaugustus I was thinking about the update path, I'm working on it rn.

The aim of this PR is to make the issue creation work when the component field in Jira is set mandatory. As I think more and more I have to realise there could be other Jira fields set required in a Jira setup. It would be nice to get this behaviour generic eventually.

I agree with never removing components from Jira issues, only adding new ones to the list.

cmd/root.go

internal/config/config.go

internal/jira/issue/issue.go

internal/options/options.go

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

internal/config/config.go

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

rappizs · 2023-08-14T07:12:16Z

(and have tests to ensure that behavior is adhered to)

Will this be part of this PR or it will be covered by #11?

justaugustus · 2023-08-15T08:24:08Z

@lgecse -- it looks like the commits have slowed here... are you ready for another review pass?

lgecse · 2023-08-15T18:30:53Z

@justaugustus I'd be happy to get a second review, thanks a lot in advance!

justaugustus

@lgecse -- Flagging a previous review comment, which I think will change some of the logic throughout.

justaugustus · 2023-09-04T13:06:06Z

internal/config/config.go

+	RepoName       string        `json:"repo-name,omitempty" mapstructure:"repo-name"`
+	JiraURI        string        `json:"jira-uri,omitempty" mapstructure:"jira-uri"`
+	JiraProject    string        `json:"jira-project,omitempty" mapstructure:"jira-project"`
+	JiraComponents string        `json:"jira-components,omitempty" mapstructure:"jira-components"`


(discussed in #150 (review))

This should be []string.

Resolved, please review.

…g_issue

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

justaugustus

Thanks @lgecse!!

lgecse requested a review from a team as a code owner August 3, 2023 11:37

lgecse force-pushed the feature/add_component_when_creating_issue branch 2 times, most recently from d6f50ee to 605d8a2 Compare August 3, 2023 14:00

justaugustus requested changes Aug 3, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

internal/config/config.go Outdated Show resolved Hide resolved

internal/config/config.go Outdated Show resolved Hide resolved

internal/config/config.go Outdated Show resolved Hide resolved

lgecse marked this pull request as draft August 3, 2023 16:10

lgecse changed the title ~~Feature/add component when creating issue~~ Make component field configurable Aug 3, 2023

lgecse force-pushed the feature/add_component_when_creating_issue branch from 017897f to f514c5c Compare August 7, 2023 11:59

lgecse marked this pull request as ready for review August 7, 2023 12:05

lgecse requested a review from justaugustus August 7, 2023 12:21

rappizs suggested changes Aug 7, 2023

View reviewed changes

lgecse added 16 commits August 7, 2023 18:59

feat: fill components field with the first project component

b129165

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

feat: added configurable component uwu-tools#149

2525200

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Using wrapped error instead of dynamic one.

e1248c7

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Solving rangeValCopy gocritic.

1d15764

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Shortening line.

b13ccaa

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Added capability to set multiple components in config.

0042166

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Added a better example to the readme.

761b079

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Refactored getComponents.

e04f887

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Missed pluralization added in readme.

d24a9d0

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Updating component when it's not on the issue

9529681

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Added omitempty to the new config variable.

619d942

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Missed pluralizations fixed.

f4b1d64

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Formatting only.

967ed91

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Formatting only.

c4926fa

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Changed c shorthand to C for components.

0d58e86

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Formatting only.

46ef7d1

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

lgecse force-pushed the feature/add_component_when_creating_issue branch from d72fc03 to 46ef7d1 Compare August 7, 2023 17:00

Applying suggested return part.

2c0f029

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

lgecse added 2 commits August 7, 2023 19:12

Applying suggested config reading part.

c68c439

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

Applying suggestions.

8ec0626

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

matewolf reviewed Aug 8, 2023

View reviewed changes

internal/config/config.go Show resolved Hide resolved

matewolf reviewed Aug 8, 2023

View reviewed changes

internal/config/config.go Outdated Show resolved Hide resolved

matewolf reviewed Aug 8, 2023

View reviewed changes

internal/config/config.go Show resolved Hide resolved

Applying suggestions.

6138b9e

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

lgecse requested review from rappizs and matewolf August 14, 2023 06:10

matewolf approved these changes Aug 14, 2023

View reviewed changes

justaugustus added 2 commits August 15, 2023 04:14

Merge branch 'main' into feature/add_component_when_creating_issue

76b802b

Merge branch 'main' into feature/add_component_when_creating_issue

00ef6d0

lgecse assigned justaugustus Aug 25, 2023

justaugustus requested changes Sep 4, 2023

View reviewed changes

lgecse and others added 3 commits September 4, 2023 15:18

Merge branch 'uwu-tools:main' into feature/add_component_when_creatin…

3507d6a

…g_issue

config: Change jira-components type to string slice.

f0f5cce

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

fix: linter errors.

d60c7de

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>

justaugustus approved these changes Sep 5, 2023

View reviewed changes

justaugustus merged commit fcec535 into uwu-tools:main Sep 5, 2023
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make component field configurable #150

Make component field configurable #150

lgecse commented Aug 3, 2023 •

edited

Loading

codecov bot commented Aug 3, 2023 •

edited

Loading

justaugustus left a comment

lgecse commented Aug 3, 2023

rappizs commented Aug 14, 2023

justaugustus commented Aug 15, 2023

lgecse commented Aug 15, 2023

justaugustus left a comment

justaugustus Sep 4, 2023

lgecse Sep 4, 2023

lgecse Sep 5, 2023

justaugustus left a comment

Make component field configurable #150

Make component field configurable #150

Conversation

lgecse commented Aug 3, 2023 • edited Loading

codecov bot commented Aug 3, 2023 • edited Loading

Codecov Report

justaugustus left a comment

Choose a reason for hiding this comment

lgecse commented Aug 3, 2023

rappizs commented Aug 14, 2023

justaugustus commented Aug 15, 2023

lgecse commented Aug 15, 2023

justaugustus left a comment

Choose a reason for hiding this comment

justaugustus Sep 4, 2023

Choose a reason for hiding this comment

lgecse Sep 4, 2023

Choose a reason for hiding this comment

lgecse Sep 5, 2023

Choose a reason for hiding this comment

justaugustus left a comment

Choose a reason for hiding this comment

lgecse commented Aug 3, 2023 •

edited

Loading

codecov bot commented Aug 3, 2023 •

edited

Loading