Skip to content

Commit f1acc4c

Browse files
authored
Update README.md
1 parent 36fb20c commit f1acc4c

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

README.md

+3-10
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,15 @@ A tool to pull all the `known_package` standard violations for a catalog and the
33

44
### What is this repository for and when do I need to use this? ###
55

6-
You don't need to unless it solves a workflow challenge involving the `known_packages` standard. This scrpt is intended to be used as an example of how a frequently requested product feature can be handled using the API. The `known_packages` standard will trigger for all internal packages that a company uses, essentially any package that is unknown to the upstream repositories. This can create a lot of noise for companies that use a lot of internal packages and the request to be able to package name match via regex has been a common request for a few years. This script automates matching packages that have triggered the known_package standard in a catalog, creates an override for the packages that match and then writes the misses to a .csv report for further investigation. If you're unfamiliar with Regex, try asking Jeeves.
6+
You don't need to unless it solves a workflow challenge involving the `known_packages` standard. The `known_packages` standard will trigger for all internal packages that a company uses, essentially any package that is unknown to the upstream repositories. This can create a lot of noise for companies that use a lot of internal packages. This script automates matching packages that have triggered the known_package standard in a catalog, creates an override for the packages that match and then writes the misses to a .csv report for further investigation.
77

88
**Note:** Creating overrides in an automated fasion should be done with care. Start with patterns that you're confident with, review the packages that are misses and also audit the override export report to ensure that a packages override isn't being created for a truly unknown package.
99

10-
**Note:** This iteration of regerride creates a package override without specifying specific releases and results in a wildcard being set for the release. This approach has drawnbacks from a security perspective. I'm evaluating adding a package lookup to pull the version information and making the overrides more granular.
10+
**Note:** This iteration of regerride creates a package override without specifying specific releases and results in a wildcard being set for the release. This approach has drawnbacks from a security perspective.
1111

1212
### How do I get set up? ###
1313

14-
* Ensure you have python 3.9 or higher installed
15-
* I recommend testing using a python virtual environment
16-
14+
* Ensure you have python 3.9 or higher installed.
1715

1816
### Configure Environment Variables and add patterns to package_patterns.txt ###
1917

@@ -25,8 +23,3 @@ There are five variables that need to be set in order for the script to execute
2523
* OVERRIDE_STATUS - an override can have a status of `approved` or `denied`
2624

2725
The regex patterns are added to a control file calls `package_patterns.txt`. Add one or more package name patterns for the script to look for matches.
28-
29-
### Who do I talk to if I have questions? ###
30-
31-
* Larry Copeland
32-
* [Team Customer Success](https://tidelift.slack.com/archives/C01EN3MKKBQ)

0 commit comments

Comments
 (0)