jenkins-pipeline-library
Jenkins pipeline library with common functionalities for CI/CD environments, mainly targeted for the implementation of the SQA baseline requirements from https://indigo-dc.github.io/sqa-baseline/
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary
Keywords
Repository
Jenkins pipeline library with common functionalities for CI/CD environments, mainly targeted for the implementation of the SQA baseline requirements from https://indigo-dc.github.io/sqa-baseline/
Basic Info
Statistics
- Stars: 11
- Watchers: 7
- Forks: 6
- Open Issues: 61
- Releases: 3
Topics
Metadata Files
README.md
A library to implement Software Quality Assurance (SQA) checks in Jenkins environments
Achievements
Institutions owning the result
Motivation
The v2 series of the present library provide a straightforward way for software projects to be compliant with common SQA practices.
In particular, the library provides the functionality to cover as much criteria as possible from the Software and Service quality baselines below:
- A set of Common Software Quality Assurance Baseline Criteria for Research Projects, online available.
- A set of Common Service Quality Assurance Baseline Criteria for Research Projects, online available.
Short intro
The SQA requirements are defined through a YAML-based configuration file that hides the
complexity of handling directly the Jenkins Pipeline as Code's
features. As a result, the SQA work, as defined in the YAML file config.yml, is
organized according to the criteria code names from the aforementioned baselines.
As an example, qc_style setting in the YAML is a direct reference to the
QC.Sty criteria in the previous software quality baseline, which establishes
the good practices that the source code shall follow in terms of style. The following
example runs flake8 to check style consistency in
a Python project:
sqa_criteria:
qc_style:
container: python-test-tools
commands:
- flake8
As it can be seen in the example, the library provides the container option as a
way to specify the agent where the check will run. In the current version, the
library supports Docker Compose as the container
orchestration tool to fire up the required set of services. In this example, the
python-test-tools is the identifier of a Docker Compose service.
You can check a full working example here
In order to get started with the library, please check our documentation.
Contributing
Jenkins CI/CD pipelines are often similar in the type of actions that are triggered. It then makes sense to have a common library for tackling them, covering different programming languages and interfaces to software lifecycle management tools.
Contributions are really welcome. Please check our contribution guidelines.
License
indigo-dc/jenkins-shared-library is licensed under Apache 2.0
Acknowledgments
The development of the v2 series is taking place under the EOSC-Synergy's project that has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement number 857647.
Owner
- Name: indigo-dc
- Login: indigo-dc
- Kind: organization
- Repositories: 257
- Profile: https://github.com/indigo-dc
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: JePL (aka Jenkins Pipeline Library)
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Samuel
family-names: Bernardo
email: samuel@lip.pt
affiliation: Laboratório de Instrumentação e Física Experimental de Partículas (LIP)
- given-names: Pablo
family-names: Orviz Fernández
email: orviz@ifca.unican.es
orcid: 'https://orcid.org/0000-0002-2473-6405'
affiliation: Spanish National Research Council (CSIC)
GitHub Events
Total
Last Year
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Pablo Orviz | o****z@i****s | 240 |
| Samuel Bernardo | s****l@l****t | 181 |
| Samuel Bernardo | s****l@g****m | 3 |
| MartaCastro | 3****o | 1 |
| David | d****n | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 103
- Total pull requests: 71
- Average time to close issues: 4 months
- Average time to close pull requests: about 1 month
- Total issue authors: 5
- Total pull request authors: 5
- Average comments per issue: 1.15
- Average comments per pull request: 0.51
- Merged pull requests: 51
- Bot issues: 0
- Bot pull requests: 7
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- samuelbernardolip (62)
- orviz (37)
- davrodgon (1)
- BorjaEst (1)
- AJRubio-Montero (1)
Pull Request Authors
- samuelbernardolip (30)
- orviz (28)
- github-actions[bot] (7)
- davrodgon (5)
- castroamarta (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- WyriHaximus/github-action-create-milestone v1 composite
- actions/checkout v2 composite
- actions/checkout v2 composite
- anothrNick/github-tag-action 1.36.0 composite
- ncipollo/release-action v1 composite
- repo-sync/pull-request v2 composite
- rlespinasse/git-commit-data-action v1.x composite