Breaking Changes
This release begins the provider migration from SDKv2 to the new Plugin Framework. As part of this, the minimum Terraform requirement has increased to 1.0+. Please update your tooling accordingly before upgrading to this version.
The deprecated parameters
property on the jenkins_job
resource has been removed. Please migrate your TF to use Terraform's native templatefile function instead.
Framework
This release introduces the Terraform Plugin Framework. This framework dramatically changes how both data sources and resources are written. The following items have been migrated already:
-
credential_username
Data Source -
credential_vault_approle
Data Source -
folder
Data Source -
job
Data Source -
view
Data Source -
credential_azure_service_principal
Resource -
credential_secret_file
Resource -
credential_secret_text
Resource -
credential_ssh
Resource -
credential_username
Resource -
credential_vault_approle
Resource -
folder
Resource -
job
Resource -
view
Resource
Additional items will be migrated as confidence increases in the new framework.
New Resources
The jenkins_view
data source and resource were added in this release.
Docs Generation
Automatic documentation generation is being introduced, rendering templates stored in the resource definitions and templates/
folder into the docs/
folder. Authors will not need to write any documentation for new resources -- a template will automatically be rendered from the schema -- but will now need to run make generate
before PRing their changes.
Example Installation Refactored
The example Docker Compose installation provided for developers encountered a name conflict with the documentation generation (which expects an examples/
folder) and was renamed from example/
to integration/
.
The terraform test framework was configured into the new integration/
folder, expanding the available ways that integration testing can be performed. This framework requires Terraform 1.6+ for contributors to run.
What's Changed
- Migrate secret file credential to Framework by @taiidani in #169
- Reduce duplication in Import block by @taiidani in #170
- Migrate secret text credential to Framework by @taiidani in #171
- Migrate SSH credential to Framework by @taiidani in #172
- Migrate View Resource & Data Source to Framework by @taiidani in #173
- Address Failing Integration Test by @taiidani in #195
- Upgrade all Go dependencies by @taiidani in #194
- Remove deprecated job "parameters" property by @taiidani in #197
- Bump the gha group with 5 updates by @dependabot in #196
- Bump the tools group in /tools with 1 update by @dependabot in #198
- Bump the integration group in /integration with 1 update by @dependabot in #188
- Allowing custom descriptions for resources by @taiidani in #200
- Decouple the folder resource from the job resource by @taiidani in #201
- Ensure resource names cannot include path characters by @taiidani in #202
- Migrate job data-source to Framework by @taiidani in #203
- Add integration test assertions for folders by @taiidani in #204
- Migrate folder data-source to Framework by @taiidani in #205
Full Changelog: v0.11-alpha2...v0.11-alpha3