diff --git a/.lycheeignore b/.lycheeignore index 0fec81f42..ec480eb7c 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -7,6 +7,7 @@ https://fonts.gstatic.com/ .*bar.* .*xxx.* .*example.* +.*YOUR.* https://id.atlassian.net https://JIRA_ID.atlassian.net https://jira_id.atlassian.net diff --git a/docs/plugins/jenkins-github-integ.zh.md b/docs/plugins/jenkins-github-integ.zh.md index ea31e847b..031b3f40b 100644 --- a/docs/plugins/jenkins-github-integ.zh.md +++ b/docs/plugins/jenkins-github-integ.zh.md @@ -133,8 +133,8 @@ tools: # release name of the jenkins helm chart, mandatory releaseName: # GitHub repo where to put the pipeline script and project. mandatory - githubRepoUrl: https://github.com/aFlyBird0/jenkins-file-test + githubRepoUrl: https://github.com/YOUR_GITHUB_ACCOUNT/YOUR_TEST_PROJECT_NAME adminList: - - aFlyBird0 + - YOUR_GITHUB_USERNAME ``` diff --git a/docs/plugins/jenkins-pipeline-kubernetes.zh.md b/docs/plugins/jenkins-pipeline-kubernetes.zh.md index ccefb8840..cda13c26f 100644 --- a/docs/plugins/jenkins-pipeline-kubernetes.zh.md +++ b/docs/plugins/jenkins-pipeline-kubernetes.zh.md @@ -114,6 +114,6 @@ tools: # path to the pipeline file, relative to the git repo root directory. default: Jenkinsfile pipelineScriptPath: Jenkinsfile # github repo url where the pipeline script is located. mandatory - githubRepoUrl: https://github.com/xxx/xxx.git + githubRepoUrl: https://github.com/YOUR_GITHUB_ACCOUNT/YOUR_TEST_PROJECT_NAME.git ``` diff --git a/docs/plugins/plugins-list.md b/docs/plugins/plugins-list.md index b4342f472..9667afd45 100644 --- a/docs/plugins/plugins-list.md +++ b/docs/plugins/plugins-list.md @@ -1,23 +1,25 @@ # Plugins List -| Type | Plugin | Note | Usage/Doc | -|--------------------------------|--------------------------------|--------------------------------|------------------------------------------| -| Issue Tracking | trello-github-integ | Trello/GitHub integration | [doc](trello-github-integ.md) | -| Issue Tracking | trello | Trello | [doc](trello.md) | -| Issue Tracking | jira-github-integ | Jira/GitHub integration | [doc](jira-github-integ.md) | -| Source Code Management | repo-scaffolding | App scaffolding | [doc](repo-scaffolding.md) | -| CI | jenkins | Jenkins installation | [doc](jenkins.md) | -| CI | githubactions-golang | GitHub Actions CI for Golang | [doc](githubactions-golang.md) | -| CI | githubactions-python | GitHub Actions CI for Python | [doc](githubactions-python.md) | -| CI | githubactions-nodejs | GitHub Actions CI for Nodejs | [doc](githubactions-nodejs.md) | -| CI | gitlabci-golang | GitLab CI for Golang | [doc](gitlabci-golang.md) | -| CI | gitlabci-generic | Generic GitLab CI | [doc](gitlabci-generic.md) | -| CD/GitOps | argocd | ArgoCD installation | [doc](argocd.md) | -| CD/GitOps | argocdapp | ArgoCD Application creation | [doc](argocdapp.md) | -| Monitoring | kube-prometheus | Prometheus/Grafana K8s install | [doc](kube-prometheus.md) | -| Observability | devlake | DevLake installation | [doc](devlake.md) | -| LDAP | openldap | OpenLDAP installation | [doc](openldap.md) | -| Secrets/Credentials Management | hashicorp-vault | Hashicorp Vault installation | [doc](hashicorp-vault.md) | +| Type | Plugin | Note | Usage/Doc | +|--------------------------------|-----------------------------|--------------------------------|---------------------------------------| +| Issue Tracking | trello-github-integ | Trello/GitHub integration | [doc](trello-github-integ.md) | +| Issue Tracking | trello | Trello | [doc](trello.md) | +| Issue Tracking | jira-github-integ | Jira/GitHub integration | [doc](jira-github-integ.md) | +| Source Code Management | repo-scaffolding | App scaffolding | [doc](repo-scaffolding.md) | +| CI | jenkins | Jenkins installation | [doc](jenkins.md) | +| CI | jenkins-pipeline-kubernetes | Create Jenkins Pipeline | [doc](jenkins-pipeline-kubernetes.md) | +| CI | jenkins-github-integ | Jenkins/GitHub integration | [doc](jenkins-github-integ.md) | +| CI | githubactions-golang | GitHub Actions CI for Golang | [doc](githubactions-golang.md) | +| CI | githubactions-python | GitHub Actions CI for Python | [doc](githubactions-python.md) | +| CI | githubactions-nodejs | GitHub Actions CI for Nodejs | [doc](githubactions-nodejs.md) | +| CI | gitlabci-golang | GitLab CI for Golang | [doc](gitlabci-golang.md) | +| CI | gitlabci-generic | Generic GitLab CI | [doc](gitlabci-generic.md) | +| CD/GitOps | argocd | ArgoCD installation | [doc](argocd.md) | +| CD/GitOps | argocdapp | ArgoCD Application creation | [doc](argocdapp.md) | +| Monitoring | kube-prometheus | Prometheus/Grafana K8s install | [doc](kube-prometheus.md) | +| Observability | devlake | DevLake installation | [doc](devlake.md) | +| LDAP | openldap | OpenLDAP installation | [doc](openldap.md) | +| Secrets/Credentials Management | hashicorp-vault | Hashicorp Vault installation | [doc](hashicorp-vault.md) | Or, to get a list of plugins, run: diff --git a/internal/pkg/show/config/plugins/jenkins-github-integ.yaml b/internal/pkg/show/config/plugins/jenkins-github-integ.yaml index 16dede72d..1467ddae2 100644 --- a/internal/pkg/show/config/plugins/jenkins-github-integ.yaml +++ b/internal/pkg/show/config/plugins/jenkins-github-integ.yaml @@ -30,6 +30,6 @@ tools: # release name of the jenkins helm chart, mandatory releaseName: # GitHub repo where to put the pipeline script and project. mandatory - githubRepoUrl: https://github.com/xxx/repo + githubRepoUrl: https://github.com/YOUR_GITHUB_ACCOUNT/YOUR_TEST_PROJECT_NAME # list of GitHub admin users adminList: [] diff --git a/internal/pkg/show/config/plugins/jenkins-pipeline-kubernetes.yaml b/internal/pkg/show/config/plugins/jenkins-pipeline-kubernetes.yaml index d74ddbbc9..c2443d833 100644 --- a/internal/pkg/show/config/plugins/jenkins-pipeline-kubernetes.yaml +++ b/internal/pkg/show/config/plugins/jenkins-pipeline-kubernetes.yaml @@ -23,4 +23,4 @@ tools: # path to the pipeline sript file path, relative to the git repo root directory. default: Jenkinsfile pipelineScriptPath: Jenkinsfile # github repo url where the pipeline script is located. mandatory - githubRepoUrl: https://github.com/xxx/xxx.git + githubRepoUrl: https://github.com/YOUR_GITHUB_ACCOUNT/YOUR_TEST_PROJECT_NAME.git