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.

Sign up for GitHub

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

Jump to bottom

fix(globalConfig): update name and rest root convention #1335

Merged
merged 23 commits into from
Oct 1, 2024
Merged

fix(globalConfig): update name and rest root convention #1335

merged 23 commits into from
Oct 1, 2024

Conversation

hetangmodi-crest
Copy link
Contributor

@hetangmodi-crest hetangmodi-crest commented Sep 10, 2024 •
edited
Loading

Issue number: ADDON-74883, #1333

Summary

Changes

Changed the validations for name and restRoot field according to the conventions specified in ADDON-74883. Additionally, the add-on will not be built if the name in globalConfig does not match the name in app.manifest.

User experience

User has to keep the same add-on name in globalConfig and app.manifest, if the name does not match then add-on will not be built. This is usually never the case unless the `app.manifest or name in globalConfig is changed manually after initializing the add-on.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

@hetangmodi-crest hetangmodi-crest added the bug Something isn't working label Sep 10, 2024
@hetangmodi-crest hetangmodi-crest self-assigned this Sep 10, 2024
@hetangmodi-crest
Copy link
Contributor Author

While generating documentation for the above feature, I encountered two major issues that affected our documentation:

  1. Markdown lint has a default indentation of 2 spaces for unordered lists (source). However, according to MkDocs, the syntax rules specify that when a list item contains multiple paragraphs, each subsequent paragraph in a list item must be indented by either 4 spaces or one tab (source).

  2. Markdown lint incorrectly raises an error for ul-style, even though we followed the convention outlined in the Markdown lint docs.

With the fix in indentation and unordered list bullets, the doc pages are rendered correctly - with correct indentation, giving better readability.

@hetangmodi-crest hetangmodi-crest marked this pull request as ready for review September 11, 2024 10:21
@artemrys
Copy link
Member

LGTM, 2 small questions and ready to merge this one!

hetangmodi-crest and others added 17 commits September 23, 2024 11:49
@hetangmodi-crest
fix:changed the validation for name and restRoot field
083f628
@hetangmodi-crest
test:add unit tests to stop the build if names are not same
56a86b0
@hetangmodi-crest
test: added unit tests according to new validations for name and rest…
6601033 
…Root
@hetangmodi-crest
doc: update doc for the behavior of stopping build
a74f595
@hetangmodi-crest
test(unit): update invalid addon-name for init
da95c79
@hetangmodi-crest
fix: fixed the input.helper code when addon-name is not same as addon…
7a40079 
…-rest-root
@hetangmodi-crest
test: updated smoke test case for init function
4ab2ec2
@hetangmodi-crest
fix(docs): fixed indentation and ul-style CI errors
51db93c
@hetangmodi-crest
docs: updated docs regarding name and restRoot
009330d
@hetangmodi-crest
fix: lowercasing restRoot name in helper code
89a9e86
@hetangmodi-crest @srv-rr-github-token
feat: restructure conf and spec file generation (#1328)
1ee6c36 
**Issue number:** ADDON-73368

## Summary

### Changes

> As per the new design, we are restructuring the code of generating
`.conf` and `.conf.spec` files that are supported by UCC.
One specific change for `inputs.conf.spec`, we are now writing the
default value and description of a field in the spec file.

### User experience

> One change for `inputs.conf.spec`, we are now writing the description
and default value of a field in the spec file if they are mentioned in
the globalConfig, apart from it there are no changes from user end, all
the files that were generated before will be generated as is with these
changes.

## Checklist

If your change doesn't seem to apply, please leave them unchecked.

* [x] I have performed a self-review of this change
* [x] Changes have been tested
* [ ] Changes are documented
* [x] PR title follows [conventional commit
semantics](https://www.conventionalcommits.org/en/v1.0.0/)

---------

Co-authored-by: srv-rr-github-token <94607705+srv-rr-github-token@users.noreply.github.com>
@hetangmodi-crest
revert(doc): remove doc changes for indentation
f19739e
@renovate @hetangmodi-crest
chore(deps): update npm (#1341)
0c14720
@hetangmodi-crest
test: added test case to check regex pattern
2f343a7
@hetangmodi-crest
chore: deleted redundant files
c6f644d
@sgoral-splunk @artemrys @hetangmodi-crest
feat(dashboard): add possibility to display CRITICAL log lvl in dashb…
44010a4 
…oard (#1337)

**Issue number:
[ADDON-74234](https://splunk.atlassian.net/browse/ADDON-74234)**

## Summary

Added possibility to display messages logged with CRITICAL level in the
error section in the monitoring dashboard.

### Changes

Global config -> dashboard has a new setting: `error_panel_log_lvl`,
which allows the user to define what log level should be displayed in
the errors section of the monitoring panel

### User experience

The user can define error log lvl in the global config. By default only
ERROR

## Checklist

If your change doesn't seem to apply, please leave them unchecked.

* [x] I have performed a self-review of this change
* [x] Changes have been tested
* [x] Changes are documented
* [x] PR title follows [conventional commit
semantics](https://www.conventionalcommits.org/en/v1.0.0/)

---------

Co-authored-by: Artem Rys <rysartem@gmail.com>
@hetangmodi-crest @renovate
@artemrys @sgoral-splunk
chore: restructure code and add test cases (#1329)
62e7623 
**Issue number:**
[ADDON-73368](https://splunk.atlassian.net/browse/ADDON-73368)

## Summary

### Changes

> Restructuring of code - moving helper functions in `utils.py` and
cleaning up duplicate code present elsewhere.

### User experience

> No change, the build process would work as it did before.

## Checklist

If your change doesn't seem to apply, please leave them unchecked.

* [x] I have performed a self-review of this change
* [x] Changes have been tested
* [ ] Changes are documented
* [x] PR title follows [conventional commit
semantics](https://www.conventionalcommits.org/en/v1.0.0/)

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Artem Rys <rysartem@gmail.com>
Co-authored-by: sgoral-splunk <138458044+sgoral-splunk@users.noreply.github.com>
@hetangmodi-crest hetangmodi-crest requested a review from a team as a code owner September 23, 2024 06:21
@hetangmodi-crest
Copy link
Contributor Author

Signed the commits which got unsigned due to expired GPG Key.

@artemrys
Copy link
Member

@hetangmodi-crest this PR removes files in the testdata folder, is that intended?

@hetangmodi-crest
Copy link
Contributor Author

Yes, I have raised PR #1349 for the same.

@hetangmodi-crest hetangmodi-crest enabled auto-merge (squash) October 1, 2024 09:28
@hetangmodi-crest hetangmodi-crest merged commit bdfa8c3 into develop Oct 1, 2024
77 checks passed
@hetangmodi-crest hetangmodi-crest deleted the fix/name-and-restRoot-issue branch October 1, 2024 11:35
@github-actions github-actions bot locked and limited conversation to collaborators Oct 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sgoral-splunk sgoral-splunk sgoral-splunk approved these changes

@kkedziak-splunk kkedziak-splunk Awaiting requested review from kkedziak-splunk

@artemrys artemrys Awaiting requested review from artemrys

Assignees

@hetangmodi-crest hetangmodi-crest

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hetangmodi-crest @artemrys @sgoral-splunk