diff --git a/README.md b/README.md index 5730d6a..50eeae4 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ See the full documentation [here](https://jfrog.com/help/r/jfrog-platform-admini ## Using the samples -This repository contains a collection of sample workers for common use cases. Feel free to use, modify, and extend these samples to accomplish your use cases. +This repository contains a collection of sample workers for common use cases. Use these code samples to jumpstart your development. These are for reference only, and up to you to adjust, test and maintain. We have created these TypeScript samples based on [Artifactory User Plugin Samples](https://github.com/jfrog/artifactory-user-plugins). diff --git a/samples/access/BEFORE_CREATE_TOKEN/token-validation/README.md b/samples/access/BEFORE_CREATE_TOKEN/token-validation/README.md index 71606bf..4234455 100644 --- a/samples/access/BEFORE_CREATE_TOKEN/token-validation/README.md +++ b/samples/access/BEFORE_CREATE_TOKEN/token-validation/README.md @@ -2,6 +2,8 @@ The worker enforces 3 checks before allowing tokens creation. +Use these code samples to jumpstart your development. These are for reference only, and up to you to adjust, test and maintain. + * The number of tokens owned by the subject should not exceeds a specific count. * If it is a user token that is been created its expiry should not exceeds 1 month (the duration can be parameterized) * If it is a service token that is been created its expiry should not exceeds 1 year (the duration can be parameterized) diff --git a/samples/artifactory/GENERIC_EVENT/README.md b/samples/artifactory/GENERIC_EVENT/README.md index 1ff0cbd..59ec925 100644 --- a/samples/artifactory/GENERIC_EVENT/README.md +++ b/samples/artifactory/GENERIC_EVENT/README.md @@ -4,6 +4,8 @@ Generic Event Workers are specialized JFrog workers that are not tied to specific Artifactory events. Instead, they are executed on demand via API calls or manual invocation. These workers are highly customizable, allowing you to perform tasks that are not bound to predefined triggers. +Use these code samples to jumpstart your development. These are for reference only, and up to you to adjust, test and maintain. + ## Key Features - **Manual Execution:** Can be triggered manually or through a specific API call. diff --git a/samples/artifactory/README.md b/samples/artifactory/README.md index 2f9cdf3..7c4078b 100644 --- a/samples/artifactory/README.md +++ b/samples/artifactory/README.md @@ -2,6 +2,8 @@ Artifactory workers allow you to automate tasks, enforce policies, and integrate with external systems based on specific events such as uploading, downloading, or managing artifacts and properties. +Use these code samples to jumpstart your development. These are for reference only, and up to you to adjust, test and maintain. + ### Available Workers This repository includes sample workers for the following Artifactory events: diff --git a/samples/runtime/AFTER_WORKLOAD_STATE_CHANGE/runtime-alerting/README.md b/samples/runtime/AFTER_WORKLOAD_STATE_CHANGE/runtime-alerting/README.md index 7116e5a..c4a9ca5 100644 --- a/samples/runtime/AFTER_WORKLOAD_STATE_CHANGE/runtime-alerting/README.md +++ b/samples/runtime/AFTER_WORKLOAD_STATE_CHANGE/runtime-alerting/README.md @@ -4,6 +4,8 @@ The `runtime-alert` project is designed to monitor and alert on vulnerabilities and risks associated with image tags in a Kubernetes cluster. It integrates with Elasticsearch for storing vulnerability data (optional) and Slack for sending alerts. +Use these code samples to jumpstart your development. These are for reference only, and up to you to adjust, test and maintain. + ## Features - Retrieves secrets for Slack webhook URL and optionally Elasticsearch API key and URL.