Releases: openshift/contra-hdsl
George
Contra HDSL v.1.1.4 "George"
Release Notes
This release includes a freshly minted test suite, as well as improvements, enhancements, and bugfixes as covered in the Change Log below.
"Breaking" Changes
This release makes no breaking changes, that we know of. Let us know if you find something!
New Features
This release includes new unit tests! Big hat-tip to the jenkins-spock framework, maintained by @awittha at @homeaway for making that possible!
Known Issues
None
Let us know if you find any issues!
Change Log
UPDATE template variable names to correspond to binding (#80)
UPDATE templates to be consistent (#81)
FIX withIndex to count lines correctly (#82)
FIX env variable calls (#84)
ADD unit test suite (#85)
FIX exception handling in createDslContainers (#88 fixes #87)
Additional Notes
This release brought to you by
Frank
Contra HDSL v.1.1.3 "Frank"
Release Notes
This release introduces improved documentation over at Read The Docs, new primitives, as well as improvements, enhancements, and bugfixes as covered in the Change Log below.
"Breaking" Changes
This release makes no breaking changes, that we know of. Let us know if you find something!
This release does mark createDslContainers() as deprecated, however
New Features
This release also introduces three new Contra HDSL primitives:
report()- Send email notificationswithHdslPod()- An easier way to create the required pods for Contral HDSL usage.withPod()- Easily add user defined pods which can be nested in the Contra HDSL pod.
Known Issues
None
Let us know if you find any issues!
Change Log
- UPDATE README for imagestream deployment (#51)
- UPDATE to newer ansible-executor container build ( #52 & #56)
- ADD report method (#54 & #58)
- FIX typo in name for jenkins-contra-slave-builder (#55)
- UPDATE to avoid NPE in executeTests (#59)
- ADD utils needed for Openshift containers to be created in productization library (plus fix typo) (#62)
- FIX references to ansible-executor and linchpin-executor container names (#63)
- ADD Read the Docs documentation (#64) Contra-HDSL @ Read The Docs
- ADD withPod method (#65)
- UPDATE environment variable names for withPod() method (#66)
- UPDATE documetntation for withPod() (#67)
- FIX typo (#72)
- UPDATE always pull images (#73)
- UPDATE add code contribution notes (#74)
- ADD ability to pull images from DockerHub easily (#75)
- UPDATE documentation to use Contra-HDSL in all locations (#76)
- ADD timeout (#77)
Additional Notes
This release brought to you by
Earl
contraDSL v.1.1.2 "Earl"
Release Notes
This release finds a few documentation fixes now that the HDSL is publicly available. Additionally, we fixed an issue with the HDSL working with jobs which had spaces or special characters in their name - although we contend you should stick to the recommend best practices for job naming and limit project names to a sane (e.g. alphanumeric) character set
"Breaking" Changes
This release makes no breaking changes, that we know of. Let us know if you find something!
New Features
None
Known Issues
None
Let us know if you find any issues!
Change Log
- FIX bug with spaces in Jenkins job names
- UPDATE README for git protocol
- ADD s2i template for jnlp slave
- UPDATE createDslContainers method
- UPDATE README to remove mention of secret configuration
Additional Notes
This release brought to you by
Doug
contraDSL v.1.1.1 "Doug"
Release Notes
This release finds us introducing one of two remaining initial DSL methods, saveArtifacts() as well as prepping the HDSL for upstream availability. We're removing the dependencies for downstream Beaker configuration to be present in the repository, which will allow public access to this repository.
"Breaking" Changes
This release makes no breaking changes, that we know of. Let us know if you find something!
New Features
- This release introduces
saveArtifacts(), which handles storing job artifacts based on options in the configuration file, or when called in the Jenkinsfile. Files to save, files to exclude, and multiple options can be implemented in either the configuration file, or amended / overwritten from the Jenkinsfile.
Known Issues
Jenkins jobs which include spaces or other characters which would generally be escaped on *nix may fail due to issues with directory generation. This is being tracked in #35 and will be resolved in the next release.
In the meantime, please name Jenkins jobs appropriately.
Let us know if you find any other issues!
Change Log
-
Updated Dockerfile and s2i template for upstreaming (#36)
- This commit removes the downstream specific files and configuration
settings and uses upstream Docker images for linchpin-executor and
ansible-executor
- This commit removes the downstream specific files and configuration
-
Added saveArtifacts dsl method (#37)
- Added saveArtifacts dsl method
-
Add documentation for saveArtifacts (#38)
- Add documentation for saveArtifacts method
- UPDATE groovyDoc documentation
- FIX typo in documentation coma->comma
Additional Notes
This release brought to you by
Carl
contraDSL v.1.1.0 "Carl"
Release Notes
This release finds us introducing our first "breaking" change, reducing the security requirements to run our executor containers, and adding new features.
Big shout-outs to the folks working on CVP for their feedback and enhancement requests.
"Breaking" Changes
This release makes a breaking change to the YAML configuration file for the contra-HDSL in order to allow for dynamic overriding and adding of variables and their values from within the Jenkinsfile.
Sections which allow for the passing of vars to Ansible playbooks now require those vars to be in a key/value arrangement, instead of a list of strings. Please update your configuration files prior to migrating to v1.1.0, as failure to do so will result in job failures.
Example
v1.0.0
---
infra:
provision:
...
configure:
playbooks:
- location: playbooks/configuration/install_vim.yml
vars:
- "foo=bar"
tests:
playbooks:
- location: playbooks/tests/verify_vim.yml
vars:
- "baz=flugelhorn"v2.0.0
---
infra:
provision:
...
configure:
playbooks:
- location: playbooks/configuration/install_vim.yml
vars:
foo: bar
tests:
playbooks:
- location: playbooks/tests/verify_vim.yml
vars:
baz: flugelhornRemoving SCC requirements
This release removes the requirement for privileged SCC, using the approach here. Please remove the previous SCC modification before upgrading to v1.1.0 using the following command, assuming your user was 'Jenkins', as failure to do so will result in job failures
oc adm policy remove-scc-from-user anyuid jenkins
New Features
-
This release introduces the ability to pass a
baseDirargument to theconfigureInfraandexecuteTestsmethods in order to provide a directory relative two the$WORKSPACEwhich will be appended to the directory path specified in the configuration YAML file. -
This release introduces the ability to override the default *-executor container names in all dsl method calls using *-executor containers. By including an
<containerType>ContainerNameargument to the dsl method call, you can specify a container to be used in-lieu of the default one.
Known Issues
Jenkins jobs which include spaces or other characters which would generally be escaped on *nix may fail due to issues with directory generation. This is being tracked in #35 and will be resolved in the next release.
In the meantime, please name Jenkins jobs appropriately.
Let us know if you find any other issues!
Change Log
- Updated ansible Dockerfile (#16)
- Fixed indent and removed new-line (#17)
- Set fixed version of fedora:27 (#18)
- Fix type-o Ephemeral (#19)
- Updated to use upstream ansible and linchpin containers (#22)
- Change key location (#25)
- Move to using the v1.1.0 upstream linchpin container (#26)
- ADD baseDir parameter to methods using playbooks (#27)
- Add ability to override params (#29)
- Fixed case when no vars exist (#31)
- Allow *-executor container names to be overriden in all primitives (#32)
- Add UUID to Openstack instance provisioning (#33)
Additional Notes
This release brought to you by
Bob
contraDSL v.1.0.0 "Bob"
Release Details
This release marks the initial public release of the contraDSL shared library. This release provides the following DSL methods:
- parseConfig
- deployInfra
- configureInfra
- executeTests
- destroyInfra
Known Issues
None
Notes
Upcoming releases will add DSL methods to handle logging and reporting functionalities.