GitHub Actions and Release Process¶

This page give information on the GitHub Actions and Release Process used by the project.

CI/CD Pipeline¶

For continuous integration and deployment this project uses GitHub Actions. The main pipeline is defined in .github/workflows/ci-jobs.yml. This pipeline will will start on every commit pushed to GitHub and then run the steps shown below:

%%{init: {'theme':'dark'}}%% graph TD; push(Developer push to GitHub) build[Build and unit tests] docs[Test doc pages creation] rpm[Test rpm package creation] insTest[Installation tests] intTest[Integration tests] checkBranch{Check branch} mainB((main)) releaseB((release/*)) otherB((other branch)) preRel[Create GitHub -pre release] releaseP[Create GitHub release] done(Pipeline end) push-->build; push-->docs; push-->rpm; build-->insTest; build-->intTest; rpm-->checkBranch; docs-->checkBranch; insTest-->checkBranch; intTest-->checkBranch; checkBranch-->mainB checkBranch-->releaseB checkBranch-->otherB releaseB-->releaseP mainB-->preRel otherB-->done releaseP-->done preRel-->done

Release Pipeline¶

After a GitHub release (also -pre) is created by the the CI/CD pipeline the .github/workflows/release-jobs.yml will be triggered. This job does the following workflow:

%%{init: {'theme':'dark'}}%% graph TD; release(GitHub release created) buildUbuntu[Build Ubuntu *.deb packages] buildDebian[Build Debian *.deb packages] docs[Documentation pages creation] repoDeb[Debian repository creation] releaseUbuntuLP[Push Ubuntu *.deb to Launchpad] releaseGH-Deb[Add all created *.deb packages to the GitHub release that triggered this pipeline] pagesRelease[Release on Github pages - Documentation and Debian repository] done(Pipeline end) checkRelease1{Check release} preRelease1(( -pre release)) fullRelease1((release)) checkRelease3{Check release} preRelease3(( -pre release)) fullRelease3((release)) buildFedora[Build Fedora *.rpm packages] checkRelease4{Check release} preRelease4(( -pre release)) fullRelease4((release)) uploadCopr[Upload Fedora *.src.rpm to Copr] buildRHEL[Build RHEL 8 *.rpm] releaseGH-Rpm[Add all created *.rpm packages to the GitHub release that triggered this pipeline] repoRpm[RPM repository creation] release-->buildUbuntu buildUbuntu-->checkRelease1 checkRelease1-->preRelease1 checkRelease1-->fullRelease1 fullRelease1-->releaseUbuntuLP releaseUbuntuLP-->buildDebian preRelease1 --> buildDebian buildDebian-->releaseGH-Deb releaseGH-Deb-->docs release-->buildFedora buildFedora-->checkRelease4 checkRelease4-->preRelease4 checkRelease4-->fullRelease4 fullRelease4-->uploadCopr uploadCopr-->buildRHEL preRelease4-->buildRHEL buildRHEL-->releaseGH-Rpm releaseGH-Rpm-->docs docs-->repoDeb repoDeb-->repoRpm repoRpm-->checkRelease3 checkRelease3-->preRelease3 checkRelease3-->fullRelease3 fullRelease3-->pagesRelease pagesRelease-->done preRelease3-->done

Launchpad release¶

Whenever a *.deb package is uploaded to the samba-exporter PPA launchpad will start a own release process. When this process is finished (usually takes about an hour), users can download and install the new package version from the PPA.

This uploads are done by the Release Pipeline for each full Release (no -pre Tag), as shown by the workflow diagram.

Copr release¶

Whenever a *.src.rpm package is uploaded to the samba-exporter COPR copr will start a own release process. When this process is finished (usually takes about 10 minutes), users can download and install the new package version from the copr reposioty.

This uploads are done by the Release Pipeline for each full Release (no -pre Tag), as shown by the workflow diagram.

Creation of release branches¶

The release process of this project is fully automated. To create a new release (not -pre) of the software use the script build/PrepareRelease.sh. Before running the script ensure you are on main branch and got the latest changes from GitHub origin. This script will:

Create a release branch from the current state at the main branch
Update the VersionMaster.txt with a new increment version on main branch
Commit the changes on the main branch
Push all changes on main and the new release branch to GitHub

Once this changes are pushed to github the CI/CD pipeline will start to run for both, main and the new release branch. This will create a new -pre Release from main as well as a new full Release from the new release branch. This new releases will then trigger two release pipeline jobs. One for the -pre and one for the full release. As shown above the full release will be published on Launchpad and copr by the release pipeline if all is fine.

As shown by the CI/CD Pipeline workflow GtiHub -pre releases will be created for every commit pushed to the main branch on GitHub.

GtiHub full releases will be created by every commit to a release/* branch and will be published for package manager (dnf/yum or apt) installation by the end user at the corresponding repositories. GtiHub full releases also publish a new version of the docs page automatically.