apply label "synced" for issues that were syncronysed

[beliaev-maksim]

Some teams do not want to have the comment on the tickets, since that leads to an internal ticket. We can offer a different functionality and apply "synced" label.

To reduce API load, it must be a prerequisite for user to have this Label created before. We can write a comment on the ticket if Label was requested but not added to the list

[lorenzo-medici]

Hi, I would like to take a shot at this.

[beliaev-maksim]

@lorenzo-medici please go

I think this also should be a configuration option for this

[lorenzo-medici]

Since the configuration is only applied through environment variables, it is currently impossible to change it for each test case.
I opened PR #58 to allow each test function to declare custom configuration of the environment variables, with cleanup at the end to let following tests proceed with the default test configuration found in dumm_env.
Please review it and give all the feedback you find necessary.
(Edit: the PR is back in draft as I noticed a mistake)

I also have a question about the feature: how does it interact with add_gh_comment if this is set? I think the most logical option is that we will both write the normal comment and add the Synced label.

[beliaev-maksim]

@lorenzo-medici that is not correct.
you are talking about the defaults DEFAULT_BOT_CONFIG
however, the actual config comes from GitHub repo. For this, you need to tweak payloads:

gh-jira-sync-bot/tests/unit/url_responses/auth_github_responses.yaml

Line 32 in 15a70e9

url: https://api.github.com:443/repos/beliaev-maksim/test-ci/contents/.github/.jira_sync_config.yaml

though, for your test we might need two separate payloads for two different cases

[lorenzo-medici]

Oh I see, I completely misunderstood the settings stuff. I will close the PR.

So for testing I should add files under url_responses that return the config with the new fields, and an endpoint to check for an existing label, and then load it in the new test cases. As you said, it should be two files with one returning the label as existing, and the other one without it to check for all situations.

[beliaev-maksim]

so, we need one response which is default (for validation of back compatibility)
and one where we return .jira_sync_config.yaml content with the new setting, like add_gh_synced_label: true or so

then you branch the logic in the main code