https://github.com/surfstudio/jenkins-pipeline-lib
Библиотека для pipeline скриптов Jenkins студии Surf
https://github.com/surfstudio/jenkins-pipeline-lib
Last synced: 7 months ago
JSON representation
Библиотека для pipeline скриптов Jenkins студии Surf
- Host: GitHub
- URL: https://github.com/surfstudio/jenkins-pipeline-lib
- Owner: surfstudio
- License: apache-2.0
- Created: 2018-10-08T12:49:54.000Z (about 7 years ago)
- Default Branch: version-3.0.0-SNAPSHOT
- Last Pushed: 2021-04-05T17:29:16.000Z (over 4 years ago)
- Last Synced: 2025-01-25T22:57:58.456Z (9 months ago)
- Language: Groovy
- Homepage: https://bitbucket.org/surfstudio/jenkins-pipeline-lib/
- Size: 21.5 MB
- Stars: 3
- Watchers: 34
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# jenkins-pipeline-lib
[Библиотека](https://jenkins.io/doc/book/pipeline/shared-libraries/) для pipeline скриптов Jenkins студии [Surf](https://surfstudio.ru/)
Содержит:
* Базовые классы для удобной работы со scripted pipeline
* Готовые pipelines для внутреннего процесса Surf
* Утилиты для распростаненных задач ci разработки Android и iOS приложений
Наследники класса Pipeline - ключевые сущности для выполнения скрипта
По сути знают что и как выполнять и определяют параметры выполнения
* "как" определяется методом run (не нужно переопределять)
* "что" определяется в методе init (нужно переопределять)
* "параметры выполнения" определяются через публичные переменные
Для создания собственного наследника необходимо переопределить метод init и в нем определенить переменные
(любая из них может быть не проинициализирована):
* **node** : Машина, на которой будет выполняться основная работа(stages)
* **stages** : Массив с обьектами определяющими блоки основной работы
* **initializeBody** : Лямбда, котороая будет выполняться перед стартом основной работы на master машине
* **finalizeBody** : Лямбда, которая будет выполняться после основной работы, как в случае успешного завершения, так и после ошибки
* **propertiesProvider** : Лямбда, которая должна вернуть массив properties, например триггеры и параметры сборки
* **preExecuteStageBody** : Лямбда, которая выполняется до выполнения Stage
* **postExecuteStageBody** : Лямбда, которая выполняется после выполнения Stage
Предусмотрены различные способы кастомизации
* изменение переменных, определяющих контекст
* изменение стратегии/тела Stage (для получения следует использовать getStage())
* замена целых Stage через метод replaceStage() или напрямую через переменную stages
* все остальное, что может прийти в голову, так как все переменные публичные
Большую часть деталей реализации следует размещать в классах ...Util для возможности переиспользования
без механизмов класса Pipeline
Предусмотрен класс EmptyPipeline для полостью кастомных скриптов
Пример импользования:
```groovy
@Library('surf-lib@version-1.0.0-SNAPSHOT')
import ru.surfstudio.ci.pipeline.tag.TagPipelineAndroid
import ru.surfstudio.ci.stage.StageStrategy
import ru.surfstudio.ci.AndroidUtil
//init
def pipeline = new TagPipelineAndroid(this)
pipeline.init()
//customization
pipeline.buildGradleTask = "clean assembleQa"
pipeline.getStage(pipeline.STATIC_CODE_ANALYSIS).strategy = StageStrategy.SKIP_STAGE
pipeline.getStage(pipeline.INSTRUMENTATION_TEST).body = {
AndroidUtil.onEmulator(this, "your avd") {
sh "./gradlew connectedTest"
}
}
//run
pipeline.run()
```
### Шаблоны
В папке templates находятся стандартные Jenkins скрипты для разных типов проектов (android, ios, ui_test)
# Разработка
Основными ветками являются ветки вида **version-X.Y.Z-SNAPSHOT**
Изменение библиотеки следует производить в feature-branch, чтобы не затронуть работающие проекты. Когда новая функциональность будет закончена, следует слить ветку с ней в master.
Для тестирования изменений в пайплайн скрипте следует импортировать библиотеку следующим образом `@Library('surf-lib@feature-branch')`. Не забываем поддерживать обратную совместимость Api библиотеки.
### Инструменты
Для работы с библиотекой удобно использовать [IntelliJ IDEA](https://www.jetbrains.com/idea/) c установленным [Groovy](http://groovy-lang.org/install.html).
В ProjectStructure на вкладке Modules директорию "src" следует пометить как "Sources"
# Кофигурация Jenkins
* Версия Jenkins >= 2.121.2
* nodes для Android сборок с меткой "android"
* nodes для iOS сборок с меткой "ios"
* ui test (todo)
### Необходимые плагины
* Blue Ocean
* Build Pipeline Plugin
* Pipeline
* Pipeline Utility Steps
* Generic Webhook Trigger
* Git plugin
* JUnit Attachments Plugin
* Poll SCM plugin
* [Bitbucket Build Status Notifier Plugin](https://github.com/surfstudio/bitbucket-build-status-notifier-plugin) surf fork
* [GitLab Build Status Notifier Plugin](https://github.com/surfstudio/gitlab-plugin) surf fork
### Конфигурация Job
Для большинства случаев используются jeninsFile (см пакет templates), размещенные в репозитории с исходным кодом.
#### Пример начальной конфигурации Job для сборки PullRequest из BitBucket (остальная конфигурация применится из pipeline при первом старте job):
* Repository URL - репозиторий с jenkinsFile
* Script Path - путь до jenkinsFile
Также необходим вебхук на события "Pull Request - Created: true; Updated: true" в Bitbucket c URL: http://jenkins.surfstudio.ru/generic-webhook-trigger/invoke?token=Your_token_for_trigger_build_remotely
## License
```
Copyright (c) 2018-present, SurfStudio LLC.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```