cd4pe_jobs

This module exists for Continuous Delivery for Puppet Enterprise to run jobs on Puppet Agents via Bolt. It contains a single task to do this and works with both *nix and Windows.

To run tests (from root of repo): bundle exec rspec spec

Release puppetlabs-cd4pe_jobs

1. Create a branch off master using the following convention:

git checkout -b 1.7.0-release

2. On a new branch based on the release branch, update CHANGELOG.md with any changes in this release and metadata.json with the new version number.
3. Commit these changes and put up a PR against the release branch you created in Step 1 and get review.
4. Once the changes have been approved and merged to the release branch, pull down the updated release branch and tag the module.

git tag -a 1.7.0 -m "1.7.0"

6. Run the https://github.com/puppetlabs/PipelinesInfra/actions/workflows/release-cd4pe_jobs.yml workflow with the release branch created above to build the tarball and push it to the forge.
7. Update the ref in PE: https://github.com/puppetlabs/pe-tasks-vanagon/blob/main/configs/components/puppetlabs-cd4pe_jobs.json. This will ensure that the new version is shipped with the next PE release.
8. Push your new tag up to the repo

git push --tags

9. Make a PR from the release branch back to master. Once this is merged the release branch should be deleted.

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

No unreleased changes.

1.7.2

Added

• Added logging to indicate that when the image pull fails, the module will assume the image is present locally and attempt to use that to run the job.

Fixed

• The module's main task is now marked as private, since users are not expected to run it directly.

1.7.1

Fixed

• Issue where jobs would report success even if the script returns 1 on Windows (Powershell)

1.7.0

Added

• Added podman support for containerized jobs. If podman is detected on a job hardware node, it will be used instead of docker.

1.6.3

Fixed

• Fixed misleading Puppet version requirements accidentally released in 1.6.2.

1.6.2

Fixed

• Fixed issue in tarball unpacking where pax header lines were causing some long filenames to be truncated.

1.6.1

Fixed

• Updated module to use File#exist? instead of deprecated (and removed in Ruby 3.2.0/Puppet 8) File#exists?

1.6.0

Added

• Added optional parameter for passing in secrets that should be set as environment variables before running the job script

1.5.0

Added

• Added verbose logging for failed http requests.

1.4.0

Added

• Added the ability to include registry credentials when pulling the Docker image.
• Added the ability to trust registries that use the same CA as CD4PE when pulling the Docker image.

1.3.0

Added

• Added the ability to pass a custom net http timeout to jobs in order to increase the time a job waits for a response when hitting CD4PE endpoints.

1.2.1

Fixed

• Fixed a problem where jobs with large output could hang indefinitely.

1.2.0

Fixed

• Improved support for jobs with substantial log output.

1.1.1

Fixed

• No longer fail when setting \$HOME on windows machines.

1.1.0

Added

• When writing job scripts, user now has access to HOME and REPO_DIR environment variables.

Fixed

• Increase read_timeout to 600 to accomadate large repositories

1.0.0

Initial release: Support for running jobs for Continuous Delivery for Puppet Enterprise on Puppet Agents managed by the Puppet Enterprise Orchestrator.