Merge pull request #20 from Mattias-/master

buildkite_pipeline: Deprecate step and env. Document configuration.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Say Media
+Copyright (c) 2021 Tink AB
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

buildkite/provider/resource_pipeline.go

@@ -60,6 +60,7 @@ var (
 			Type:          schema.TypeMap,
 			Optional:      true,
 			ConflictsWith: []string{"configuration"},
+			Deprecated:    "Use configuration instead that supports YAML steps",
 			Elem: &schema.Schema{
 				Type: schema.TypeString,
 			},
@@ -77,6 +78,7 @@ var (
 			Type:          schema.TypeList,
 			Optional:      true,
 			ConflictsWith: []string{"configuration"},
+			Deprecated:    "Use configuration instead that supports YAML steps",
 			Elem: &schema.Resource{
 				Schema: map[string]*schema.Schema{
 					"type": {

website/docs/r/pipeline.md

@@ -20,19 +20,17 @@ resource "buildkite_pipeline" "build_something" {
 
   default_branch = "master"
   repository     = "[email protected]:my-org/awesome-repo.git"
-  
+
   github {
     build_pull_request_forks = true
   }
 
-  step {
-    name    = ":pipeline: Fetch pipeline"
-    type    = "script"
-    command = "buildkite-agent pipeline upload"
+  configuration = <<EOF
+steps:
+  - command: "buildkite-agent pipeline upload"
+    label: ":pipeline:"
+EOF
 
-    agent_query_rules = [
-    ]
-  }
 }
 ```
 
@@ -50,9 +48,11 @@ The following arguments are supported:
 
 * `default_branch` - (Optional) the default branch to build. Defaults to `master`
 
-* `env` - (Optional) pipeline environment variables
+* `env` - (Optional, Deprecated) pipeline environment variables. Switch to use `configuration` with YAML pipeline steps.
+
+* `step` - (Optional, Deprecated) nested block list configuring the steps to run. Must provide at least one. Switch to use `configuration` with YAML pipeline steps.
 
-* `step` - (Required) nested block list configuring the steps to run. Must provide at least one.
+* `configuration` - (Optional) String in YAML format with step configuration.
 
 * `bitbucket_settings` - (Optional)