Merge pull request #469 from splunk/remove-contribution-references

Remove contribution/PR references - repo no longer accepting new changes

Author: pyth0n1c

CONTRIBUTING.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
 

MAINTAINERS.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                                             |
 | --------------------- | ------------------------------------------------------- |

README.md

@@ -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
 

contentctl/actions/inspect.py

@@ -314,8 +314,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

contentctl/output/conf_output.py

@@ -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. 
+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.