From 27a2b074c7fdde1efa8070bddde4063d4e50d8ce Mon Sep 17 00:00:00 2001 From: Jose Hernandez Date: Thu, 5 Feb 2026 13:11:11 -0500 Subject: [PATCH] Remove contribution/PR references - repo no longer accepting new changes - Delete CONTRIBUTING.md - Remove Contribution Guide section and CONTRIBUTING link from README.md - Remove contributing reference from MAINTAINERS.md - Remove 'raise an issue in contentctl GitHub' from conf_output.py exception - Remove commented GitHub issues reference from inspect.py - Remove PR-related comments from Sample_CICD_Templates.md --- CONTRIBUTING.md | 43 -------------------------------- MAINTAINERS.md | 2 +- README.md | 3 --- contentctl/actions/inspect.py | 2 -- contentctl/output/conf_output.py | 3 +-- docs/Sample_CICD_Templates.md | 8 +----- 6 files changed, 3 insertions(+), 58 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 894bcd13..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,43 +0,0 @@ -# Contributing Guidelines - -Thank you for your interest in contributing to our repository! Whether it's a bug -report, new feature, or question, we greatly value feedback and contributions from -our community. Read through this document before submitting any issues or pull -requests to ensure we have all the necessary information to effectively respond -to your bug report or contribution. - - -In addition to this document, review our [Code of Conduct](CODE_OF_CONDUCT.md). -For any code of conduct questions or comments, send an email to oss@splunk.com. - -# First Things First - -1. **When in doubt, open an issue** - For almost any type of contribution, the first step is opening an issue. Even if you think you already know what the solution is, writing down a description of the problem you're trying to solve will help everyone get context when they review your pull request. If it's truly a trivial change (e.g. spelling error), you can skip this step -- but as the subject says, when it doubt, [open an issue](https://github.com/splunk/contentctl/issues). - -2. **Only submit your own work** (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. - -# Contributor License Agreement - -Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html). - -## Ways to Contribute - -### Bug Reports -Bugs! Ugh! When there's a mismatch between intended behavior, and the actual results, that's a bug. To help us understand what's happening, we want to make sure you're working on the latest version. - -Once you've confirmed that the bug still exists in the latest version, check to make sure its not something we already know about on the [Github Issues tab](https://github.com/splunk/contentctl/issues). When you open a bug, please fill out the issue template for a bug report, supplying as much relevant information as you can. - -### Feature Requests & Proposals -If you've thought of a way that `contentctl` can be better, we want to hear about it! There's a specific issue type for these requests [here](https://github.com/splunk/contentctl/issues) that helps us keep track. Please describe the feature you'd want to see, and if possible, a potential implementation idea. If you're not familiar enough with the codebase to describe the implementation, that's fine too - -### Documentation Changes - -Sometimes, the documentation doesn't match reality. Sometimes, examples might be out of date, or spelling or grammar might make something difficult to read or understand. We welcome updates to our documentation for any of the above reasons, and for any others too! - -### Contributing Code - -As with other types of contributions, please open an issue first. This helps to make sure we don't have duplicate people working on the same problem, ensures that the change is solved once, and that we can help you find the right approach before spending a ton of time on a PR. As above, when in doubt, please open an issue. - -## Review Process -We're very appreciative of everyone that wants to make a contribution. We will attempt to review them in a timely manner. As a reminder, opening [an issue](https://github.com/splunk/contentctl/issues) before you spend time on a PR can help make this process smoother. It can also help prevent rejection because someone else was working on it already, or because its incompatible with other in-flight work or long term goals. - diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 88c35c31..7a6b730d 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,6 +1,6 @@ # Overview -This document contains a list of maintainers in this repo. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). +This document contains a list of maintainers in this repo. ## Current Maintainers diff --git a/README.md b/README.md index 814ea1da..7b6976ca 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,6 @@ Read more about how `contentctl` can help test and validate your content in a re ## Sample CICD Workflows Already using `contentctl`, or looking to get started with it already configured in GitHub Actions? [Our guide](docs/Sample_CICD_Templates.md) includes workflows to help you build and test your app. -## Contribution Guide -Read [the Contribution Guidelines](CONTRIBUTING.md) for this project before opening a Pull Request. - ## Ecosystem | Project | Description | | --------------------- | ------------------------------------------------------- | diff --git a/contentctl/actions/inspect.py b/contentctl/actions/inspect.py index 40c0ff27..f36d609b 100644 --- a/contentctl/actions/inspect.py +++ b/contentctl/actions/inspect.py @@ -220,8 +220,6 @@ def inspectAppCLI(self, config: inspect) -> None: # "\n\tpython3 -m pip install splunk-appinspect" # f"\n\tsplunk-appinspect inspect {self.getPackagePath(include_version=False).relative_to(pathlib.Path('.').absolute())} --mode precert") - # else: - # print("splunk-appinspect is only compatable with Python3.9 at this time. Please see the following open issue here: https://github.com/splunk/contentctl/issues/28") # print("******WARNING******") return diff --git a/contentctl/output/conf_output.py b/contentctl/output/conf_output.py index b90d0121..39d77832 100644 --- a/contentctl/output/conf_output.py +++ b/contentctl/output/conf_output.py @@ -253,8 +253,7 @@ def packageAppTar(self) -> None: def packageAppSlim(self) -> None: raise Exception( - "Packaging with splunk-packaging-toolkit not currently supported as slim only supports Python 3.7. " - "Please raise an issue in the contentctl GitHub if you encounter this exception." + "Packaging with splunk-packaging-toolkit not currently supported as slim only supports Python 3.7." ) try: import logging diff --git a/docs/Sample_CICD_Templates.md b/docs/Sample_CICD_Templates.md index d6bf6dcb..606eb5af 100644 --- a/docs/Sample_CICD_Templates.md +++ b/docs/Sample_CICD_Templates.md @@ -76,19 +76,13 @@ jobs: python -m pip install --upgrade pip pip install contentctl==5.0.0 - # Running contentctl test with a few arguments, before running the command make sure you checkout into the current branch of the pull request. This step only performs unit testing on all the changes against the target-branch. In most cases this target branch will be develop - # Make sure we check out the PR, even if it actually lives in a fork - # Instructions for pulling a PR were taken from: - # https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally - name: Run ContentCTL test for changes against target branch run: | echo "Current Branch (Head Ref): ${{ github.head_ref }}" echo "Target Branch (Base Ref): ${{ github.base_ref }}" git pull > /dev/null 2>&1 - #We checkout into a new branch - new_branch_for_testing to avoid name collisions with develop incase the forked PR is from develop git fetch origin pull/${{ github.event.pull_request.number }}/head:new_branch_for_testing - #We must specifically get the PR's target branch from security_content, not the one that resides in the fork PR's forked repo git switch new_branch_for_testing contentctl test --disable-tqdm --no-enable-integration-testing --container-settings.num-containers 2 --post-test-behavior never_pause mode:changes --mode.target-branch ${{ github.base_ref }} echo "contentctl test - COMPLETED" @@ -117,4 +111,4 @@ jobs: echo "The Unit testing is completed. See details in the unit-testing job summary UI " ``` -The Testing workflow again has some things that are particular to the setup required for [splunk/security_content](https://github.com/splunk/security_content). Notably, the repository being checked out is hardcoded and should be updated to your repo. There is some additional behavior present related to our repository recieving PRs from forks and ensuring the right jobs are run in the right environment that are also potentially not necessary for your own private repository. Also, there are still hardcoded references to `DA-ESS-ContentUpdate-latest.tar.gz` that should be updated. Additionally, this job relies on [an additional script](https://github.com/splunk/security_content/blob/develop/.github/workflows/format_test_results.py) in its last step to format the results nicely for Github Actions. \ No newline at end of file +The Testing workflow again has some things that are particular to the setup required for [splunk/security_content](https://github.com/splunk/security_content). Notably, the repository being checked out is hardcoded and should be updated to your repo. There are still hardcoded references to `DA-ESS-ContentUpdate-latest.tar.gz` that should be updated. Additionally, this job relies on [an additional script](https://github.com/splunk/security_content/blob/develop/.github/workflows/format_test_results.py) in its last step to format the results nicely for Github Actions. \ No newline at end of file