feat: Add scheduled project trigger

[tleed5]

Background

The terraform provider currently doesn't support scheduled project triggers

Internal Story: sc-73797

Results

fixes #607

This PR adds support for the scheduled project trigger type by adding a new resource octopusdeploy_project_scheduled_trigger

Example

Once daily schedule

resource "octopusdeploy_project_scheduled_trigger" "once_daily" {
  name        = "Once Daily"
  description = "This is a once daily schedule"
  project_id  = octopusdeploy_project.non_tenanted.id
  space_id    = octopusdeploy_project.non_tenanted.space_id
  deploy_new_release_action {
    destination_environment_id = octopusdeploy_environment.env_1.id
  }
  once_daily_schedule {
    start_time   = "2024-03-22T09:00:00"
    days_of_week = ["Tuesday", "Wednesday", "Monday"]
  }
}

Tenanted Schedule

resource "octopusdeploy_project_scheduled_trigger" "tenanted_trigger" {
  name = "Cron Tenanted"
  project_id = octopusdeploy_project.tenanted.id
  space_id = octopusdeploy_project.tenanted.space_id
  tenant_ids = [octopusdeploy_tenant.tenant_team_a.id, octopusdeploy_tenant.tenant_team_b.id]
  deploy_new_release_action {
    destination_environment_id = octopusdeploy_environment.env_1.id
  }
  cron_expression_schedule {
    cron_expression = "0 0 06 * * Mon-Fri"
  }
}

Runbook Schedule

resource "octopusdeploy_project_scheduled_trigger" "runbook" {
  name        = "Cron Runbook"
  description = "This is a Cron schedule"
  project_id  = octopusdeploy_project.non_tenanted.id
  space_id    = octopusdeploy_project.non_tenanted.space_id
  run_runbook_action {
    target_environment_ids = [octopusdeploy_environment.env_1.id]
    runbook_id             = octopusdeploy_runbook.non_tenanted_runbook.id
  }
  cron_expression_schedule {
    cron_expression = "0 0 06 * * Mon-Fri"
  }
}

[kevjt]

Was this removed unintentionally as a result of running the terraform-plugin-docs tool?

[tleed5]

Yeah i'm guessing so, ill have a look to see why it was removed

[kevjt]

Might be because I didn't have the example listed in the examples folder with the import.sh thing

[tleed5]

Figured it out, you have to specify the description in resource definition. Ill include this and the adding the example to the examples directory in this PR

	return &schema.Resource{
		CreateContext: resourceExternalFeedCreateReleaseTriggerCreate,
		DeleteContext: resourceExternalFeedCreateReleaseTriggerDelete,
		Description:   "This resource manages External feed triggers (release creation type) in Octopus Deploy.",
		Importer:      getImporter(),
		ReadContext:   resourceExternalFeedCreateReleaseTriggerRead,
		Schema:        getExternalFeedCreateReleaseTriggerSchema(),
		UpdateContext: resourceExternalFeedCreateReleaseTriggerUpdate,
	}

[kevjt]

Nice!

[kevjt]

I assume these newlines were also added automatically by the terraform-plugin-docs tool?

[tleed5]

Yup. Did it do the same thing for you when you updated the docs last time?

[kevjt]

Not for me, but we might have used different versions of the tool 🤷

[kevjt]

Oh is this how the examples in the docs are supposed to be populated by the docs generator tool?

[tleed5]

Yup i've added one for the external feed so the doc generator won't overwrite the changes again

[kevjt]

Is it expected to only take the first source environment from the list?

[tleed5]

Yeah, for some reason the API contract has SourceEnvironments as an array but it can only have one element in it otherwise it fails validation. Even on the frontend you can only select one environment. So rather than duplicating that logic on the provider I opted to just having a string property

[kevjt]

What do these ForceNew attributes mean for the schema's properties?

[tleed5]

It causes the resource to be destroyed and recreated instead of updated when this property changes. So in this case if the project ID changes it will destroy it and recreate the trigger against the new project, without it will attempt to use the update endpoint which "succeeds" but the project doesn't actually change.

[kevjt]

Oh, is this a known issue with the update API then?

[kevjt]

LGTM!