Skip to content

Latest commit

 

History

History
399 lines (241 loc) · 7.11 KB

macros.md

File metadata and controls

399 lines (241 loc) · 7.11 KB

ppl--pr-labels()

HELPS DEALING WITH THE PR LABELS

 Params:
 $1: the action to perform (add,remove)
 $2: the label to add or delete

 Actions:
 - add {label}
 - remove {label}

ppl--gate-check()

EXECUTES PRELIMINAR CHECKS ABOUT THE CURRENT PR

 Business Rules:
 - The PR title must match the given format rules

 Params:
 $1: the label to check

ppl--check-pr-bom-state()

EXECUTES THE BOM ALIGNMENT CHECK ABOUT THE CURRENT PR

 Business Rules:
 - The PR bom should be aligned with the latest published BOM

ppl--checkout-branch()

EXECUTES THE CLONE AND CHECKOUT OF THE CURRENT DEFAULT REPO AND REF

 Special Options:
 --token:  Overrides the default CI token. Can be useful to be able to push from the cloned repo.

ppl--status-report()

PRINTS A GENERIC STATUS REPORT ABOUT CURRENT RUN

ppl--npm()

MACRO OPERATIONS RELATED TO NPM

 Params:
 $1: action to apply

 Actions:
 - FULL-BUILD           Executes a full and clean npm build in full respect of the lock file (which in fact is required)
                        Options for FULL-BUILD:
                          -public-url                    the path on which app-builder is exposed (default: /app-builder)
                          --domain                        the path of the main application (default: /entando-de-app)
                          --admin-console-integration     flag for the admin console integration enabling (default: false)
 - PUBLISH              Prepares the repo for publication by setting on it the proper version number
 - MTX-NPM-SCAN-{type}  Runs a type of npm scan (LINT, SASS-LINT, COVERAGE)

ppl--bom()

MACRO OPERATIONS RELATED TO THE BOM

 Params:
 $1: action to apply

 Actions:
 - update-bom    if the projects belong to a bom automatically updates the bom when a new project version is generated

 Requires:
 - maven projects
 - ENTANDO_OPT_REPO_BOM_URL
 - ENTANDO_OPT_REPO_BOM_MAIN_BRANCH

ppl--scan()

MACRO OPERATIONS RELATED TO CODE AND DEPENDECIES SCANS

 Params:
 $1: action to apply

 Actions:
 - snyk:   runs a snyk based scan of the current project

 Env vars:
 - ENTANDO_OPT_SNYK_ORG                the project organization under the snyk cloud service
 - ENTANDO_OPT_SNYK_PRJ                the project name under the snyk cloud service
 - ENTANDO_OPT_SNYK_SCAN_BASE_IMAGES   if true activates the scan of the base images in container scans

ppl--repl()

Development shell to test the pipeline code in interactive mode

 > It generates a temporary area where the current project is git-cloned
 > It can access almost all the internal function and global variables

 Please note these two helpers:

 - @r    command prefix (@r ppl-...) to prevent the called function to unexpectedly close the repl session
 - @rr   command to reload the scripts if you made some change to the code

ppl--publication()

HELPER for triggering publications

 Params:
 $1: the release action to apply

 Actions:
 - tag-git-version:         applies the snapshot tag to the current commit
 - tag-git-pseudo-version:  applies a tag similar to the snapshot tag but that doesn't triggers workflows

ppl--publication._determine_snapshot_version_tag()

Determine the current snapshot version numbers

 Supported Conditions:
 - On a PR creation/update commit
 - On a PR merge commit

ppl--check-pr-format()

EXECUTES PRELIMINAR CHECKS ABOUT THE CURRENT PR

 Business Rules:
 - The PR title must match the given format rules

 Params:
 $1: the format rules to respect or nothing for the default

ppl--pr-preflight-checks()

EXECUTES PRELIMINAR CHECKS ABOUT THE CURRENT PR

 > Checks the format of the PR title:
 > Checks the format of the project version number on PR
 > Checks that the development PR is compatible with the current mainline version (optional via ENTANDO_OPT_MAINLINE)
 > Runs optional custom check (user provided script "custom-pr-check.sh")

ppl--mvn()

MACRO OPERATIONS RELATED TO MAVEN

 Params:
 $1: action to apply

 Actions:
 - FULL-BUILD        executes a full and clean npm build+test
 - PUBLISH           publishes the maven artifact for development
                     in the process, sets on it the proper version number and rebuilds the artifact
 - GA-PUBLICATION    publishes the maven artifact for general availability
                     doesn't alter the sources like PUBLISH
 - MTX-MVN-SCAN-SONAR          Executes a full sonar scan, including the coverage report
 - MTX-MVN-SCAN-OWASP          Executes a full owasp scan
 - MTX-MVN-POST-DEPLOYMENT-TESTS  Executes the tests designed to run on a preview environment

ppl--mvn.generate-build-cache-key()

Generates the key to store the build cache

ppl--enp()

MACRO OPERATIONS RELATED TO ENTANDO PROJECT FILES

 Params:
 $1: action to apply

 Actions:
 - FULL-BUILD        executes a full and clean npm build+test
 - PUBLISH           executes a publication

ppl--docker()

MACRO OPERATIONS RELATED TO DOCKER

 Params:
 $1: action to apply

 Actions
 - publish:  Builds one or more artifacts, image and pushes it to the image regitry.
             Mandatory Vars:
              - ENTANDO_OPT_DOCKER_ORG
              - ENTANDO_OPT_DOCKER_USERNAME
              - ENTANDO_OPT_DOCKER_PASSWORD

ppl--docker.is_release_version_number()

Tells if a docker image tag is a release tag

ppl--setup-feature-flags()

SETUP IN THE CI A SET OF FEATURE-FLAGS ACCORDING WITH USER DIRECTIVES

 The funtion takes the features to check as parametes and the directives from the environment

 Params:
 $*: a list of features to check

 @see _ppl_get_feature_action for details

ppl--setup-features-list()

SETUP IN THE CI A LIST OF ENABLED FEATURES ACCORDING WITH USER PROVIDED FEATURES DIRECTIVES

 @see _ppl_get_feature_action for details

 Options
 -p prefix mode

 Normal Params:
 $1: a list of features to check

 Prefix mode params:
 $1: prefix used to filter ENTANDO_OPT_GLOBAL_FEATURES and ENTANDO_OPT_FEATURES

ppl--generic()

PROXY FUNCTION FOR MULTI-BUILD-SYSTEM MACRO OPERATIONS

 Params:
 $1: action to apply

 Actions:
  - FULL-BUILD   see equivalent on ppl--mvn|ppl--npm
  - PUBLISH      see equivalent on ppl--mvn|ppl--npm
  - MTX-MVN-SCAN-*   see equivalent on ppl--npm
  - MTX-NPM-SCAN-*   see equivalent on ppl--npm
  - MTX-SCAN-SNYK    runs a snyk scan (see ppl--scan)
  - GENERATE-BUILD-CACHE-KEY generate the key to store the build cache
  - GENERATE-BUILD-TARGET-DIR generates statement to set the target dir