There are four or five things that need re-usable terms for generic consumers:
- An Automation Plan
- The action of creating an Automation Request
- (It is this one that is perhaps the most important, as users do not care about “creating a request”, but about what they request will do)
- An Automation Request
- An Automation Result
- Perhaps, The action of tearing down an Automation Result’s associated resource(s)
- (Although this does depend on what the providers intend to do on teardown, if they support it)
I propose that we provide guidance suggesting the use of the following terms for each of the sub-domains. Where there are multiple terms, any can be used. (Other terms can of course be used if the implementors see fit.) Terms in bold are ones that I think are non-obvious (i.e. not just “{sub-domain} {plan|request|result}”) and my preferred phrase for that term.
I would like people who have implemented consumers in each of these sub-domains to see if these phrases would work in their products, and whether they are using anything better/different.
Build
- An Automation Plan:
- “Build definition”
- “Build plan”
- “Build script”
- The action of creating an Automation Request:
- “Build” (verb)
- “Execute a build”
- “Start a build”
- “Run a build”
- An Automation Request:
- “Build” (noun)
- “Build request”
- An Automation Result:
- “Build” (noun)
- “Build result”
- Teardown:
- “Clear build”
- “Delete build”
Test
- An Automation Plan:
- “Test execution plan”
- “Test run definition”
- “Test plan” (conflicts with the testing domain, as the Plan might be a single test not a test plan)
- “Test run script” (again, conflicts with the concept of a test script)
- The action of creating an Automation Request:
- “Execute a test run”
- “Start a test run”
- “Run tests”
- “Run testing”
- An Automation Request:
- “Test run”
- “Test execution”
- “Test run request”
- “Test execution request”
- An Automation Result:
- “Test result”
- “Test run result”
- “Test execution result”
- Teardown:
- “Clear test results”
- “Delete test results”
Deployment
- An Automation Plan:
- “Deployment plan”
- “Deployment script”
- The action of creating an Automation Request:
- “Deploy”
- “Start deployment”
- “Create a [new] deployment”
- An Automation Request:
- “Deployment request”
- “Deployment in progress” (if not completed/cancelled)
- An Automation Result:
- “A deployment”
- “An existing deployment” (if still deployed)
- “A previous deployment”
- Teardown:
- “Undeploy”
- “Tear down”
- (N.B. My feeling/preference is that “tear down” is a verb, and “teardown” is a noun - MP)
