An interim release of the Policy Framework for Policy Framework stakeholders, to be included in the next ONAP Maintenance release on that branch. x.y.z is the ONAP release version and n is the Policy Framework Interim release number on that ONAP release version.

bumpSnapshots.sh - generate commits to bump the snapshot version and update references to snapshot references
               on any repos that need to be bumped or updated

       usage:  bumpSnapshots.sh [-options]

       options
         -h           - this help message
         -d data_file - the policy release data file to use, defaults to './pf_release_data.csv'
         -l location  - the location of the policy framework repos on the file system,
                        defaults to './'
         -i issue-id  - issue ID in the format POLICY-nnnn

 examples:
  bumpSnapshots.sh -l /home/user/onap -d /home/user/data/pf_release_data.csv -i POLICY-1234
    bump snapshots on the repos at location '/home/user/onap' using the release data
    in the file '/home/user/data/pf_release_data.csv'

generateCommit.sh - generates a new commit or a patch on an existing commit for PF releases

bumpSnapshots.sh - generate commits to bump the snapshot version and update references to snapshot references
               on any repos that need to be bumped or updated

       usage:  bumpSnapshots generateCommit.sh [-options]

       options
         -h                - this help message
         -d data_file -l location       - the location of the policy release data file to use, defaultsframework repos on the file system,
                             defaults to './pf_release_data.csv'
         -l locationr repo      - the  location  of- the policy repo frameworkto reposwhich onto thecommit
  file  system,
     -i issue-id       - issue ID in the format POLICY-nnnn
         -e commit-header   defaults to './'- the header for the commit
         -im issuecommit-idmessage  - the issuemessage IDbody infor the format POLICY-nnnn
 examplescommit

 example:
  bumpSnapshotsgenerateCommit.sh -l /home/usergit/onap -dr /home/user/data/pf_release_data.csvpolicy/pap -i POLICY-1234 -e commit-header -m commit-message
    bumpcreate snapshotsa onnew thecommit reposor atupdate location '/home/user/onap' using the release data
    in the file '/home/user/data/pf_release_data.csv'an existing commit on policy/pap with the given details

getReleaseData

generateCommit.sh - generatesgets ainformation new commit or a patch on an existing commit for PF releasesfrom the checked out Policy Framework repos for the release process

       usage:  generateCommit getReleaseData.sh [-options]

       options
         -h           - this help message
         -b branch    - the branch to release on, defaults to 'master'
         - this help messaged data_file - the policy release data file to create, defaults to './pf_release_data.csv'
         -l location       - the location of the policy framework repos on the file system,
                         defaults    defaults to './'         -r repo           - the policy repo to which to commit
   

mkart.sh - create the release yaml file to release the current snapshot on the current repo

       -i issue-id       - issue ID in the format POLICY-nnnn
         -e commit-header  - the header for the commit
 usage:  mkart.sh [-options]

       options
         -d  -m commit-messagecreate -a therelease messageyaml bodyfoie for the commit
 example:
  generateCommita repo that has Docker images

mkdock.sh -l /home/git/onap -r policy/pap -i POLICY-1234 -e commit-header -m commit-message
    create a new commit or update an existing commit on policy/pap with the given details create the release container yaml file to release the docker images on the current repo

     usage:  mkdock.sh docker-container-name1 docker-container-name2 ...

on release changes, generate commits to set the snapshot version and update
references on any repos that reference other repos

getReleaseData.sh - gets information from the checked out Policy Framework repos for the release process

       usage:  getReleaseData newReleaseSnapshots.sh [-options]

       options
         -h           - this help message
         -b branch    - the branch to release on, defaults to 'master' help message
         -d data_file - the policy release data file to createuse, defaults to './pf_release_data.csv'
         -l location  - the location of the policy framework repos on the file system,
                        defaults to './'

mkart.sh - create the release yaml file to release the current snapshot on the current repo
       usage:  mkart.sh [-options]
       options
     -i  issue-id  -d -issue createID ain releasethe yaml foie for a repo that has Docker images

mkdockformat POLICY-nnnn

 examples:
  newReleaseSnapshots.sh - create the release container yaml file to release the docker images on the current repo
     usage:  mkdock.sh docker-container-name1 docker-container-name2 ...l /home/user/onap -d /home/user/data/pf_release_data.csv -i POLICY-1234
    set snapshots on the repos at location '/home/user/onap' using the release data
    in the file '/home/user/data/pf_release_data.csv'

releasePhase.sh - execute a certain policy framework release phase

       usage:  releasePhase.sh [-options]

       options
         -h           - this help message
         -d data_file - the policy release data file to use, defaults to './pf_release_data.csv'
         -l location  - the location of the policy framework repos on the file system,
                        defaults to './'
         -i issue-id  - issue ID in the format POLICY-nnnn
         -p phase     - the release phase, a positive integer

 examples:
  releasePhase.sh -l /home/user/onap -d /home/user/data/pf_release_data.csv -i POLICY-1234 -p 3
    perform release phase 3 on the repos at location '/home/user/onap' using the release data
    in the file '/home/user/data/pf_release_data.csv'

releaseRepo.sh - release the specified repository by generating the release yaml file and the release commit

       usage:  releaseRepo.sh [-options]

       options
         -h           - this help message
         -d data_file - the policy release data file to use, defaults to './pf_release_data.csv'
         -l location  - the location of the policy framework repos on the file system,
                        defaults to './'
         -r repo      - the policy repo to release
         -i issue-id  - issue ID in the format POLICY-nnnn

 examples:
  releaseRepo.sh -l /home/user/onap -d /home/user/data/pf_release_data.csv -r policy/common -i POLICY-1234
    release the 'policy/common' repo at location '/home/user/onap' using the release data
    in the file '/home/user/data/pf_release_data.csv'

releaseRepoImages.sh - release the docker images for the specified repository by generating the release yaml file and
               the release commit
       usage:  releaseRepoImages.sh [-options]

       options
         -h           - this help message
         -d data_file - the policy release data file to use, defaults to './pf_release_data.csv'
         -l location  - the location of the policy framework repos on the file system,
                        defaults to './'
         -r repo      - the policy repo to release
         -i issue-id  - issue ID in the format POLICY-nnnn

 examples:
  releaseRepoImages.sh -l /home/user/onap -d /home/user/data/pf_release_data.csv -r policy/common -i POLICY-1234
    release the 'policy/common' repo at location '/home/user/onap' using the release data
    in the file '/home/user/data/pf_release_data.csv'

updateOomImages.sh - generate an OOM commit to update the versions of Policy Framework images in values.yaml files

       usage:  updateOomImages.sh [-options]

       options
         -h           - this help message
         -d data_file - the policy release data file to use, defaults to './pf_release_data.csv'
         -l location  - the location of the OOM repo on the file system,
                        defaults to './'
         -i issue-id  - issue ID in the format POLICY-nnnn

 examples:
  updateOomImages.sh -l /home/user/onap -d /home/user/data/pf_release_data.csv -i POLICY-1234
    update the version of policy framework images at location '/home/user/onap/oom' using the release data
    in the file '/home/user/data/pf_release_data.csv'

updateParentRef.sh - update the parent reference in a POM file

       usage:  updateParentRef.sh [-options]

       options
         -h             - this help message
         -f pom_file    - the POM file to update
         -g group_id    - the parent group ID
         -a artifact_id - the parent artifact ID
         -v version     - the parent version

updateRefs.sh - updates the inter-repo references in Policy Framework POM files

       usage:  updateRefs.sh [-options]

       options
         -h           - this help message
         -d data_file - the policy release data file to use, generated by the 'getReleaseData.sh' script,
                        defaults to './pf_release_data.csv'
         -l location  - the location of the policy framework repos on the file system,
                        defaults to './'
         -r repo      - the policy repo to update
         -p           - update policy/parent references
         -c           - update policy/common references
         -m           - update policy/model references
         -o           - update policy/drools-pdp references
         -x           - update policy/apex-pdp references
         -k           - update docker base images in Dockerfiles
         -f           - update release data in policy parent
         -s           - update release references to snapshot references,
                        if omitted, snapshot references are updated to release references

 examples:
  updateRefs.sh -pcm -r policy/pap
              update the parent, common, and models references of policy/pap
              to the current released version

  updateRefs.sh -c -m -s -r policy/api
              update the common and models references of policy/api
              to the current snapshot version