26
26
27
27
Depending on your language or a framework, you may create your own
28
28
implementation of
29
- the [ .ahoy.yml] ( https://github.com/integratedexperts /dx/blob/master/.ahoy.yml )
29
+ the [ .ahoy.yml] ( https://github.com/drevops /dx/blob/master/.ahoy.yml )
30
30
file.
31
31
32
32
Check it out locally and run ` ahoy build ` to see how it works (you need to have
33
33
Ahoy installed):
34
34
35
- ```
35
+ ``` bash
36
36
$ ahoy build
37
- ==> Building project
37
+ [INFO] Building project
38
38
Would run pre-flight checks.
39
39
Would remove containers and all build files.
40
40
Would build and start Docker containers.
41
41
Would install project and all dependencies.
42
42
Would run provision operations.
43
- ==> Build complete
44
43
Would find problems with current project setup.
45
44
Would print project information
45
+ [INFO] Build complete
46
46
```
47
47
48
48
## Existing implementations
@@ -54,7 +54,7 @@ Would print project information
54
54
## Similar and partial implementations (that would be nice to unify)
55
55
56
56
- GovCMS (PHP,
57
- Drupal, [ https://github.com/govCMS/govCMS /blob/7.x- 3.x/.ahoy.yml ] ( https://github.com/govCMS/govCMS /blob/7.x- 3.x/.ahoy.yml ) )
57
+ Drupal, [ https://github.com/govCMS/GovCMS /blob/3.x-develop /.ahoy.yml ] ( https://github.com/govCMS/GovCMS /blob/3.x-develop /.ahoy.yml ) )
58
58
- SDP (PHP,
59
59
Drupal, [ https://github.com/dpc-sdp/dev-tools/blob/master/.ahoy.yml ] ( https://github.com/dpc-sdp/dev-tools/blob/master/.ahoy.yml ) )
60
60
@@ -76,7 +76,7 @@ Would print project information
76
76
77
77
- Install project and all dependencies.
78
78
79
- ## ` provision ` (for web-based projects)
79
+ ## ` provision `
80
80
81
81
- Perform application-level operations to guarantee consistent application
82
82
state.
@@ -90,8 +90,8 @@ Would print project information
90
90
91
91
## ` test-unit `
92
92
93
- - Run unit tests
94
- - Agnostic to framework
93
+ - Run unit tests.
94
+ - Agnostic to framework.
95
95
- Must run all tests if no arguments provided.
96
96
97
97
## ` test-bdd `
@@ -110,20 +110,19 @@ Would print project information
110
110
111
111
## ` clean `
112
112
113
- - Bring project to default state
114
- - Remove installed dependencies
113
+ - Bring project to default state.
114
+ - Remove installed dependencies.
115
115
116
116
## ` update `
117
- -
118
117
119
- - Update ahoy configuration itself
120
- - Possible to update some platform files
118
+ - Update ahoy configuration itself.
119
+ - Possible to update some platform files.
121
120
122
121
## ` doctor `
123
122
124
- - Identify any problems with the stack
125
- - Offer resolution suggestions
126
- - Run before build in pre-flight mode
123
+ - Identify any problems with the stack.
124
+ - Offer resolution suggestions.
125
+ - Run before build in pre-flight mode.
127
126
128
127
## Command wrapper
129
128
@@ -133,6 +132,11 @@ to create and maintain unified commands within a single YAML file.
133
132
[ .ahoy.yml] ( https://github.com/drevops/dx/blob/main/.ahoy.yml ) file
134
133
in this repository is an example of the command configuration file.
135
134
135
+ [ .ahoy.local.example.yml] ( https://github.com/drevops/dx/blob/main/.ahoy.local.example.yml )
136
+ file in this repository is an example of the local command configuration file
137
+ that would be excluded from the repository. This file is used to define
138
+ additional local commands.
139
+
136
140
### Ahoy config
137
141
138
142
- Contain as less custom code as possible: rely on scripts or binaries that can
0 commit comments