Create post upgrade task function and command to regenerate readme with helm-doc

Add a function to post upgrade tasks functions.sh to regenerate the README with helm-doc and add the command to allowedPostUpgradeCommands. This will then be added to every package renovate.json in this issue https://repo1.dso.mil/platform-one/big-bang/bigbang/-/issues/1110 to automatically regenerate for renovate update MRs

changed the description

added priority4 teamci/pipelines labels

set weight to 3

changed milestone to %1.33.0

changed iteration to Big Bang Iterations Apr 19, 2022 - May 2, 2022

assigned to @evan.rush

added statusdoing label

mentioned in merge request !10 (merged)

added statusreview label and removed statusdoing label

added statusdoing label and removed statusreview label

closed with commit a7e97e2e

added statusreview label and removed statusdoing label

Artifact update problem

Renovate failed to update artifacts related to this branch. You probably do not want to merge this MR as-is.

Renovate will retry this branch, including artifacts, only when one of the following happens:

• any of the package files in this branch needs updating, or
• the branch becomes conflicted, or
• you click the rebase/retry checkbox if found above, or
• you rename this MR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: tests/images.txt

Post-upgrade command 'source $CI_MROJECT_DIR/functions.sh && helm-docs' does not match allowed pattern 'source $CI_MROJECT_DIR/functions.sh && helm-docs'

File name: chart/values.yaml

Post-upgrade command 'source $CI_MROJECT_DIR/functions.sh && helm-docs' does not match allowed pattern 'source $CI_MROJECT_DIR/functions.sh && helm-docs'

File name: chart/Chart.yaml

Post-upgrade command 'source $CI_MROJECT_DIR/functions.sh && helm-docs' does not match allowed pattern 'source $CI_MROJECT_DIR/functions.sh && helm-docs'

File name: chart/Chart.yaml

Post-upgrade command 'source $CI_MROJECT_DIR/functions.sh && helm-docs' does not match allowed pattern 'source $CI_MROJECT_DIR/functions.sh && helm-docs'

File name: chart/values.yaml

Post-upgrade command 'source $CI_MROJECT_DIR/functions.sh && helm-docs' does not match allowed pattern 'source $CI_MROJECT_DIR/functions.sh && helm-docs'

Adding for context, this is the error when adding the postupgrade task as follows:

  "packageRules": [
    {
      "matchDatasources": ["docker"],
      "groupName": "Ironbank",
      "registryUrls": ["https://registry1.dso.mil"],
      "postUpgradeTasks":  {
        "commands": [
          "source $CI_PROJECT_DIR/functions.sh && helm-docs"
        ],
        "fileFilters": ["README.md"]
      }
    }
  ],

I suspect maybe using $CI_PROJECT_DIR in the renovate.json and config.js files will not work? Maybe we need to figure out the full paths of those and use those?

reopened

Re-opening issue to address the above.

removed statusreview label

changed milestone to %1.34.0

changed iteration to Big Bang Iterations May 3, 2022 - May 16, 2022

unassigned @evan.rush

assigned to @razzle

added statusdoing label

created branch 8-create-post-upgrade-task-function-and-command-to-regenerate-readme-with-helm-doc to address this issue

mentioned in merge request !14 (merged)

added statusreview label and removed statusdoing label

closed with commit ac06ce60

mentioned in commit package-validation@a7e97e2e

mentioned in commit package-validation@ac06ce60