eeacms/gitflow repository overview

⁠eea.docker.gitflow

Used in jenkins to test github pull requests prerequisites and make releases.

⁠Pull request checks on eggs:

To run from jenkins:

⁠Variables

1. GIT_NAME - Mandatory, repository name, example: "eea.testegg"
2. GIT_ORG - Organisation name, default: "eea"
3. GIT_VERSIONFILE - Location of the Versionfile, default: "eea/testegg/version.txt"
4. GIT_HISTORYFILE - Location of the changelog, default:"docs/HISTORY.txt"

⁠The checks:

1. History file updated in pull request
2. Version file updated in pull request
3. Version is not present in git tags
4. Version format is number.number
5. New version is bigger than last released version or no versions released yet

⁠Egg Release on commit to master

To run from jenkins:

⁠Variables

1. GIT_NAME - Mandatory, repository name, example: "eea.testegg"
2. GIT_ORG - Organisation name, default: "eea"
3. GIT_VERSIONFILE - Location of the Versionfile, default: "eea/testegg/version.txt"
4. GIT_USERNAME - User that will do the changes in github, default "EEA Jenkins"
5. GIT_EMAIL - Email that will do the changes in github, default value set in code
6. EGGREPO_URL - URL of Repository for python eggs - default: https://eggrepo.eea.europa.eu/⁠
7. KGS_GITNAME - Repository name on github for KGS (Docker image for Plone with EEA Common Add-ons) - default: eea.docker.kgs
8. KGS_VERSIONS_PATH - Location of file from KGS where the version of the egg is configured - default: src/plone/versions.cfg
9. NODEJS_VERSION - version of nodejs used in javascript runs
10. LANGUAGE - if "javascript" will run the javascript releases

⁠Generic Gitflow variables

1. GITFLOW_BEHAVIOR - TAG_ONLY to only create tag, and RUN_ON_TAG all release steps after it's already created
2. DOCKERHUB_REPO - repository to upgrade
3. RANCHER_CATALOG_PATHS - where to upgrade in catalog, can be empty to upgrade all existing templates
4. DEPENDENT_DOCKERFILE_URL - list of paths separated by space with the format: GIT_ORG/GIT_NAME/blob/GIT_BRANCH/Dockerfile
5. TRIGGER_MAIN_URL - to trigger the dockerhub image build in case it's not triggered ( webhook failure )
6. RANCHER_CATALOG_ADD_MINUS - true, will add "-1" to the release in the rancher catalog
7. RANCHER_CATALOG_SAME_VERSION - true, will not release catalog, but modify in the current one
8. EXTRACT_VERSION_SH - script location that if exits, will run to calculate the next image version

⁠Jenkins secret variables

1. EGGREPO_USERNAME, EGGREPO_PASSWORD - user and password for eggrepo
2. PYPI_USERNAME, PYPI_PASSWORD - user and password for Pypi
3. GIT_TOKEN - token used for GitHub API
4. NPM_TOKEN - token used for NPM login
5. DOCKERHUB_USER, DOCKERHUB_PASS - used in DockerHub login

⁠Specific variables

1. RUN_YARN_BEFORE_PUBLISH - set to anything to run yarn before npm publish

⁠The release steps:

1. Release on EGGREPO_URL
2. Create tag on GIT_NAME repo with released version
3. Update in KGS_GITNAME repo with the released version

⁠Plone release on commit to master

Is done only if there are files changed since the latest release.

Updates local Dockerfiles(DEPENDENT_DOCKERFILE_URL) with the new release number.

Version is calculated using current date - YY.MM.DD ( when HOTFIX variable is given - YY.MM.DD-RELEASE) or using a script located at the EXTRACT_VERSION_SH variable value, which is by default src/docker/calculate_next_release.sh Waits for dockerhub to finish the build succesfully before creating the Rancher Catalog release and triggering Dockerfile updates(DEPENDENT_DOCKERFILE_URL) and triggering Docker Hub repo builds (TRIGGER_RELEASE).

To run from jenkins:

⁠Variables

1. GIT_NAME - Mandatory, repository name, example: "eea.docker.kgs"
2. GIT_ORG - Organisation name, default: "eea"
3. GIT_USERNAME - User that will do the changes in github, default "EEA Jenkins"
4. GIT_EMAIL - Email that will do the changes in github, default value set in code
5. DOCKERHUB_REPO - Dockerhub repository name ( for example eeacms/kgs for KGS )
6. DOCKERHUB_REPO_SUFIX - If the image is also released with a suffix ( for example will update both IMAGE:VERSION and IMAGE:VERSION-SUFIX)
7. RANCHER_CATALOG_PATHS - If given will upgrade only the catalog paths after the release. If not given, will be calculated from the catalog locating all current releases containing DOCKERHUB_REPO
8. RANCHER_CATALOG_SAME_VERSION - If given, will not create new catalog releases, but upgrade the last one found in the catalog with the new release of DOCKERHUB_REPO
9. DEPENDENT_DOCKERFILE_URL - Space separated list of Dockerfiles witch will contain the new release of the DOCKERHUB_REPO - 2 types:
   • Local Dockerfile - same branch, same repo, will share a release with the main Dockerfile so will be updated before the release on github - for example - devel/Dockerfile
   • Remote Dockerfile - other branch or other repo - format is - ORG/REPO/blob/BRANCH/PATH_TO_Dockerfile - will be updated after the release on Dockerhub and catalog
10. EXTRACT_VERSION_SH - location of script to calculate the next release, if file is not found will use the YY.MM.DD release.

⁠Jenkins secret variables

1. GIT_TOKEN - Mandatory, the token used for GitHub API
2. DOCKERHUB_USER - Mandatory, the token used for Dockerhub release trigger and check status
3. DOCKERHUB_PASS - Mandatory, the token used for Dockerhub release trigger and check status
4. TRIGGER_MAIN_URL - Trigger url for DOCKERHUB_REPO to resubmit in case of failure to start
5. TRIGGER_RELEASE - Space separated list of DEPENDENT_DOCKERFILE_REPOS;TRIGGER_OF_THE_REPO - will be triggered after the DEPENDENT_DOCKERFILE_URL upgrades.

⁠EEA.DOCKER.PLONE release

⁠EEA.DOCKER.PLONESAAS release

⁠Apache/Varnish release on commit to master

To run from jenkins:

and