Difference between revisions of "Continuous Integration: Actions Jenkins Pipeline"

From Gcube Wiki
Jump to: navigation, search
(Action Report)
(gCubeActions Pipeline Project)
Line 1: Line 1:
 
= gCubeActions Pipeline Project =
 
= gCubeActions Pipeline Project =
A pipeline to execute configurable actions over a list of Git repositories:
+
A pipeline to execute configurable actions over a list of Git repositories.
  
 
The pipeline project is available at: https://jenkins.d4science.org/job/Pipeline-gCubeActions/
 
The pipeline project is available at: https://jenkins.d4science.org/job/Pipeline-gCubeActions/
 
  
 
== Parameters==
 
== Parameters==
Line 10: Line 9:
 
* List of Repositories: A plain text file, one line for each Git repository name to update.
 
* List of Repositories: A plain text file, one line for each Git repository name to update.
 
* Action Root: The root URL of the Bash fragment to execute.
 
* Action Root: The root URL of the Bash fragment to execute.
* Action File: The relative path under the Action Root of a Bash script  
+
* Action File: The relative path under the Action Root of a script to execute.
  
 
Example:
 
Example:
  
 
[[File:Jenkins_action_pipeline_params.png|800px]]
 
[[File:Jenkins_action_pipeline_params.png|800px]]
 +
 +
== How does it work ==
 +
Given the parameters, the pipeline performs the following steps:
 +
1. clones one repository at the time from <code>Git Root/Repo Name</code>
 +
 +
2. downloads the action file from <code>Action Root/Action File</code> in the root folder of the repository
 +
 +
3. runs the action file using the root folder of the repository as working dir
 +
 +
4. pushes the repository back to Gitea
 +
 +
Every change to the Git repository **MUST** be done by the action file. The pipeline is in charge only
 +
to push the repository to the remote origin.
 +
  
 
== Triggers ==
 
== Triggers ==

Revision as of 03:54, 26 January 2021

gCubeActions Pipeline Project

A pipeline to execute configurable actions over a list of Git repositories.

The pipeline project is available at: https://jenkins.d4science.org/job/Pipeline-gCubeActions/

Parameters

  • Git Root: The URL of the parent organization that includes all the listed repositories.
  • List of Repositories: A plain text file, one line for each Git repository name to update.
  • Action Root: The root URL of the Bash fragment to execute.
  • Action File: The relative path under the Action Root of a script to execute.

Example:

Jenkins action pipeline params.png

How does it work

Given the parameters, the pipeline performs the following steps: 1. clones one repository at the time from Git Root/Repo Name

2. downloads the action file from Action Root/Action File in the root folder of the repository

3. runs the action file using the root folder of the repository as working dir

4. pushes the repository back to Gitea

Every change to the Git repository **MUST** be done by the action file. The pipeline is in charge only to push the repository to the remote origin.


Triggers

No triggers are defined because the pipeline is expected to be manually launched by the Release Manager.

Jenkins Pipeline Definition

Git Repository

The definition of the gCube release pipeline is maintained in this Git Repository: ...

Requirements on Jenkins

Jenkins Pipeline Execution

Action Report

If the pipeline execution succeeds, it sends a report to the release manager.

The report includes the following information for each Git repository where the action was executed:

  • repo name
  • SCM url
  • result (completed or failed)

Here's an example of a tag report:

Jenkins-action-report.png

Back to the CI guide.