Skip to content

Conversation

@artemrys
Copy link
Member

@artemrys artemrys commented Mar 26, 2025

Issue number: ADDON-78488

PR Type

What kind of change does this PR introduce?

  • Feature
  • Bug Fix
  • Refactoring (no functional or API changes)
  • Documentation Update
  • Maintenance (dependency updates, CI, etc.)

Summary

Changes

This PR introduces support for comparing GlobalConfig objects (__eq__ implementation) and exposes is_yaml as a property.

User experience

N/A

Checklist

If an item doesn't apply to your changes, leave it unchecked.

Review

  • self-review - I have performed a self-review of this change according to the development guidelines
  • Changes are documented. The documentation is understandable, examples work (more info)
  • PR title and description follows the contributing principles
  • meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket)

Tests

See the testing doc.

  • Unit - tests have been added/modified to cover the changes
  • Smoke - tests have been added/modified to cover the changes
  • UI - tests have been added/modified to cover the changes
  • coverage - I have checked the code coverage of my changes (see more)

Demo/meeting:

Reviewers are encouraged to request meetings or demos if any part of the change is unclear

@artemrys artemrys marked this pull request as ready for review March 26, 2025 17:19
@artemrys artemrys requested a review from a team as a code owner March 26, 2025 17:19
@hetangmodi-crest
Copy link
Contributor

Should we also update .coveragrc as we are targeting to reach 100% coverage for the entire source code?

**Issue number:** ADDON-78488

### PR Type

**What kind of change does this PR introduce?**
* [x] Feature
* [ ] Bug Fix
* [ ] Refactoring (no functional or API changes)
* [ ] Documentation Update
* [ ] Maintenance (dependency updates, CI, etc.)

## Summary

### Changes

This feature allows UCC to initialize a `GlobalConfig` from
`app.manifest` file. This will be later used to create a `GlobalConfig`
if there is no such exists which enables UCC to support `.conf`-only
add-ons in a better way.

### User experience

N/A

## Checklist

If an item doesn't apply to your changes, leave it unchecked.

### Review

* [x] self-review - I have performed a self-review of this change
according to the [development
guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines)
* [ ] Changes are documented. The documentation is understandable,
examples work [(more
info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines)
* [x] PR title and description follows the [contributing
principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests)
* [ ] meeting - I have scheduled a meeting or recorded a demo to explain
these changes (if there is a video, put a link below and in the ticket)

### Tests

See [the testing
doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test).

* [x] Unit - tests have been added/modified to cover the changes
* [ ] Smoke - tests have been added/modified to cover the changes
* [ ] UI - tests have been added/modified to cover the changes
* [ ] coverage - I have checked the code coverage of my changes [(see
more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage)

**Demo/meeting:**

*Reviewers are encouraged to request meetings or demos if any part of
the change is unclear*
@artemrys artemrys requested a review from a team as a code owner March 27, 2025 12:27
@pull-request-size pull-request-size bot added size/L and removed size/M labels Mar 27, 2025
@github-actions
Copy link

Code Coverage 🎉

Type PR Develop Change Status
Line Coverage 86.99% 86.95% 0.04% 🟢 Increased
Branch Coverage 80.34% 80.27% 0.07% 🟢 Increased

@artemrys artemrys changed the title chore: introduce __eq__ and is_yaml methods for GlobalConfig feat: introduce GlobalConfig.from_app_manifest Mar 27, 2025
@artemrys artemrys merged commit d5edd88 into develop Mar 28, 2025
93 of 94 checks passed
@artemrys artemrys deleted the chore/gc-update branch March 28, 2025 14:47
@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants