splunk / splunk/contentctl

Feature Request: Macro Validation Ignorelist

Open
#119 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
139
Forks
52
Avg merge
1h 16m
Merged PRs (30d)
3

Description

Relevant discussion: https://splunk-usergroups.slack.com/archives/C78NT6CQ7/p1710531076795219

It may make sense to supply via the contentctl.yml config a list of macros that are expected to be present on a system but may not be packaged directly in the generated app. This allows for macros bundled in other apps to be utilized without being wrapped in another macro just for inclusion here. We may want to also consider a more complex macro object in the list allowing for notes about what app the macro is present in, or some form of stub that can be placed in the macros/ directory.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Slack discussion and how contentctl.yml configuration relates to generated apps and the macros/ directory. Define the ignorelist format, including whether entries can carry app notes or stubs, and verify that expected external macros are accepted without being packaged directly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.