From eaffb8f1f67055cefc181213d05f76868fcd49d9 Mon Sep 17 00:00:00 2001
From: iProbe <iprobe@noreply.localhost>
Date: Fri, 9 May 2025 17:40:44 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20readme.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 readme.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/readme.md b/readme.md
index 2857fad..ee959cf 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,22 @@
+## 原理
+jenkins-cron项目访问到jenkins使用gradle编译项目的缓存目录，删除缓存目录中的文件，达到清理缓存的目的。
+触发jenkins中相应job编译，刷新缓存。
+
+## 使用方法
+* 前提 *
+* 1. jenkins中对应的job需要配置布尔类型的only_build参数，当该参数为true时，仅编译，不进行发布。 *
+* 2. jenkins中对应的job中需要配置触发远程构建时的身份令牌，目前只支持同一个身份令牌。 *
+
+## 编译
+```shell
 CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "-s -w" -o jenkins-cron
+```
+
+## 打包镜像
+```shell
+docker build -t swr.cn-east-3.myhuaweicloud.com/turingsyn/ops/jenkins-cron:v1.9 .
+docker push swr.cn-east-3.myhuaweicloud.com/turingsyn/ops/jenkins-cron:v1.9
+```
+
+## k8s使用
+* 需要挂载gradle使用的缓存目录