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

From Gcube Wiki
Jump to: navigation, search
(→‎Jenkins Pipeline Definition)
(→‎gCubeActions Pipeline Project)
Line 8: Line 8:
 
* Git Root: The URL of the parent organization that includes all the listed repositories.
 
* 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.
 
* 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 script to execute.
 
* Action File: The relative path under the Action Root of a script to execute.
 
* Action File: The relative path under the Action Root of a script to execute.
  
Line 14: Line 14:
  
 
[[File:Jenkins_action_pipeline_params.png|800px]]
 
[[File:Jenkins_action_pipeline_params.png|800px]]
 +
 +
=== Sample Action ===
 +
The following Action adds the LICENSE.md file to the Git repository:
 +
<pre>
 +
#!/usr/bin/env bash
 +
if [[ ! -f LICENSE.md ]]; then
 +
    curl <my URL>/LICENSE.md -o LICENSE.md
 +
    git add LICENSE.md
 +
    git commit -m "Add LICENSE.md."
 +
fi
 +
</pre>
  
 
== How does it work ==
 
== How does it work ==

Revision as of 04:37, 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 script to execute.
  • Action File: The relative path under the Action Root of a script to execute.

Example:

Jenkins action pipeline params.png

Sample Action

The following Action adds the LICENSE.md file to the Git repository: 

#!/usr/bin/env bash
if [[ ! -f LICENSE.md ]]; then
    curl <my URL>/LICENSE.md -o LICENSE.md
    git add LICENSE.md
    git commit -m "Add LICENSE.md."
fi

How does it work

Upon passing valid 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: https://code-repo.d4science.org/manuele.simi/gCubeActionExecutor

Actions and repo lists are defined in this Git repository: https://code-repo.d4science.org/manuele.simi/gCubeActionsFiles. But in theory, they could be stored in any location accessible via HTTP/HTTPS.

Requirements on Jenkins

Jenkins Pipeline Execution

Given the following list of repositories: 

to_update_1
to_update_2
to_update_3

the execution page will look like the following:

Jenkins action pipeline execution.png

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.

Retrieved from "https://wiki.gcube-system.org/index.php?title=Continuous_Integration:_Actions_Jenkins_Pipeline&oldid=33807"