Skip to content

Commit 3eeea3f

Browse files
andrey-helldarandrey-helldar
committed
Added upgrade guide for 7.x
1 parent e7105f2 commit 3eeea3f

File tree

7 files changed

+296
-24
lines changed

7 files changed

+296
-24
lines changed

‎docs/docs_libraries.tree

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE instance-profile
3+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
4+
5+
<instance-profile id="docs_libraries"
6+
name="docs_libraries" is-library="true" start-page="snippets_composer.topic">
7+
8+
<toc-element topic="snippets_composer.topic" />
9+
</instance-profile>

‎docs/topics/snippets_composer.topic

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/html-entities.dtd">
3+
<topic
4+
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
5+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6+
is-library="true"
7+
id="snippets_composer"
8+
title="snippets composer">
9+
10+
<snippet id="update">
11+
<p>
12+
Then you need to update the dependencies:
13+
</p>
14+
15+
<code-block lang="bash">
16+
composer update
17+
</code-block>
18+
</snippet>
19+
</topic>

‎docs/topics/upgrade-4.topic

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,7 @@
8282
}
8383
</code-block>
8484

85-
<p>
86-
Then you need to update the dependencies:
87-
</p>
88-
89-
<code-block lang="bash">
90-
composer update
91-
</code-block>
85+
<include from="snippets_composer.topic" element-id="update" />
9286
</chapter>
9387
</chapter>
9488

‎docs/topics/upgrade-5.topic

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,7 @@
5252
}
5353
</code-block>
5454

55-
<p>
56-
Then you need to update the dependencies:
57-
</p>
58-
59-
<code-block lang="bash">
60-
composer update
61-
</code-block>
55+
<include from="snippets_composer.topic" element-id="update" />
6256
</chapter>
6357
</chapter>
6458
</topic>

‎docs/topics/upgrade-6.topic

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,7 @@
8282
}
8383
</code-block>
8484

85-
<p>
86-
Then you need to update the dependencies:
87-
</p>
88-
89-
<code-block lang="bash">
90-
composer update
91-
</code-block>
85+
<include from="snippets_composer.topic" element-id="update" />
9286
</chapter>
9387

9488
<chapter title="Changed the namespace" id="changed_the_namespace">

‎docs/topics/upgrade-7.topic

Lines changed: 264 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,275 @@
1313
<show-structure depth="2" />
1414

1515
<procedure title="High-Impact Changes" id="high_impact_changes" type="choices">
16-
<step><a href="#aaaaaaaaa" /></step>
16+
<step><a href="#updating_dependencies" /></step>
17+
<step><a href="#strict_typification" /></step>
18+
<step><a href="#removed_deprecated_methods_and_properties" /></step>
1719
</procedure>
1820

1921
<procedure title="Minor-Impact Changes" id="minor_impact_changes">
20-
<step><a href="#aaaaaaaaa" /></step>
22+
<step><a href="#laravel_10_is_now_unsupported" /></step>
23+
<step><a href="#removed_operations_upgrade_console_command" /></step>
2124
</procedure>
2225

2326
<procedure title="Low-Impact Changes" id="low_impact_changes">
24-
<step><a href="#aaaaaaaaa" /></step>
27+
<step><a href="#added_suffixes_for_classes" /></step>
28+
<step><a href="#renamed_traits" /></step>
29+
<step><a href="#replaced_config_helper_with_config_data" /></step>
30+
<step><a href="#replaced_dragon_code_simple_dto_with_spatie_laravel_data" /></step>
2531
</procedure>
32+
33+
<chapter title="Updating Dependencies" id="updating_dependencies">
34+
<p>
35+
You should update the following dependencies in your application's <code>composer.json</code> file:
36+
</p>
37+
38+
<code-block lang="json">
39+
{
40+
"require": {
41+
"dragon-code/laravel-deploy-operations": "^7.0"
42+
}
43+
}
44+
</code-block>
45+
46+
<include from="snippets_composer.topic" element-id="update" />
47+
</chapter>
48+
49+
<chapter title="Laravel 10 is now unsupported" id="laravel_10_is_now_unsupported">
50+
Laravel 10 version is no longer supported due to the lack of event classes required for
51+
<format style="bold">%product_short%</format>
52+
.
53+
</chapter>
54+
55+
<chapter title="Removed `operations:upgrade` console command" id="removed_operations_upgrade_console_command">
56+
We decided to drop support for the <code>php artisan operations:upgrade</code> console command.
57+
It does not exist now.
58+
</chapter>
59+
60+
<chapter title="Strict typification" id="strict_typification">
61+
<p>
62+
A strict typification has been added to all the project files.
63+
</p>
64+
65+
<code-block lang="php">
66+
declare(strict_types=1);
67+
</code-block>
68+
</chapter>
69+
70+
<chapter title="Replaced `ConfigHelper` with `ConfigData`" id="replaced_config_helper_with_config_data">
71+
<p>
72+
The <code>DragonCode\LaravelDeployOperations\Helpers\ConfigHelper</code> class has been removed and
73+
<code>DragonCode\LaravelDeployOperations\Data\Config\ConfigData</code>, which is a Data object, is now used instead.
74+
</p>
75+
76+
<p>
77+
For example,
78+
</p>
79+
80+
<code-block lang="diff">
81+
- $this->config->path('some'); // /operations/some
82+
- config('deploy-operations.transactions.enabled'); // false
83+
- config('deploy-operations.async'); // false
84+
85+
+ $this->config->path . 'some'; // /operations/some
86+
+ $this->config->transactions->enabled; // false
87+
+ $this->config->async; // false
88+
</code-block>
89+
</chapter>
90+
91+
<chapter
92+
title="Replaced `dragon-code/simple-dto` with `spatie/laravel-data
93+
`" id="replaced_dragon_code_simple_dto_with_spatie_laravel_data">
94+
<p>
95+
This tidied up the handling of settings and options.
96+
</p>
97+
<p>
98+
If you used a direct reference to the <code>Helpers/Config</code> and
99+
<code>Values/Options</code> classes, update your code.
100+
</p>
101+
</chapter>
102+
103+
<chapter title="Added suffixes for classes" id="added_suffixes_for_classes">
104+
<table>
105+
<tr>
106+
<td>New Name</td>
107+
<td>Old Name</td>
108+
</tr>
109+
<tr>
110+
<td><code>Commands\InstallCommand</code></td>
111+
<td><code>Commands\Install</code></td>
112+
</tr>
113+
<tr>
114+
<td><code>Commands\MakeCommand</code></td>
115+
<td><code>Commands\Make</code></td>
116+
</tr>
117+
<tr>
118+
<td><code>Commands\OperationsCommand</code></td>
119+
<td><code>Commands\Operations</code></td>
120+
</tr>
121+
<tr>
122+
<td><code>Commands\FreshCommand</code></td>
123+
<td><code>Commands\Fresh</code></td>
124+
</tr>
125+
<tr>
126+
<td><code>Commands\RefreshCommand</code></td>
127+
<td><code>Commands\Refresh</code></td>
128+
</tr>
129+
<tr>
130+
<td><code>Commands\ResetCommand</code></td>
131+
<td><code>Commands\Reset</code></td>
132+
</tr>
133+
<tr>
134+
<td><code>Commands\RollbackCommand</code></td>
135+
<td><code>Commands\Rollback</code></td>
136+
</tr>
137+
<tr>
138+
<td><code>Commands\StatusCommand</code></td>
139+
<td><code>Commands\Status</code></td>
140+
</tr>
141+
<tr>
142+
<td><code>Processors\FreshProcessor</code></td>
143+
<td><code>Processors\Fresh</code></td>
144+
</tr>
145+
<tr>
146+
<td><code>Processors\InstallProcessor</code></td>
147+
<td><code>Processors\Install</code></td>
148+
</tr>
149+
<tr>
150+
<td><code>Processors\MakeProcessor</code></td>
151+
<td><code>Processors\Make</code></td>
152+
</tr>
153+
<tr>
154+
<td><code>Processors\OperationsProcessor</code></td>
155+
<td><code>Processors\Operations</code></td>
156+
</tr>
157+
<tr>
158+
<td><code>Processors\RefreshProcessor</code></td>
159+
<td><code>Processors\Refresh</code></td>
160+
</tr>
161+
<tr>
162+
<td><code>Processors\ResetProcessor</code></td>
163+
<td><code>Processors\Reset</code></td>
164+
</tr>
165+
<tr>
166+
<td><code>Processors\RollbackProcessor</code></td>
167+
<td><code>Processors\Rollback</code></td>
168+
</tr>
169+
<tr>
170+
<td><code>Processors\StatusProcessor</code></td>
171+
<td><code>Processors\Status</code></td>
172+
</tr>
173+
<tr>
174+
<td><code>Helpers\GitHelper</code></td>
175+
<td><code>Helpers\Git</code></td>
176+
</tr>
177+
<tr>
178+
<td><code>Helpers\SorterHelper</code></td>
179+
<td><code>Helpers\Sorter</code></td>
180+
</tr>
181+
<tr>
182+
<td><code>Services\MigratorService</code></td>
183+
<td><code>Services\Migrator</code></td>
184+
</tr>
185+
<tr>
186+
<td><code>Services\MutexService</code></td>
187+
<td><code>Services\Mutex</code></td>
188+
</tr>
189+
<tr>
190+
<td><code>Values\OptionsData</code></td>
191+
<td><code>Values\Options</code></td>
192+
</tr>
193+
</table>
194+
</chapter>
195+
196+
<chapter title="Renamed traits" id="renamed_traits">
197+
<table>
198+
<tr>
199+
<td>New Name</td>
200+
<td>Old Name</td>
201+
</tr>
202+
<tr>
203+
<td><code>Concerns\HasAbout</code></td>
204+
<td><code>Concerns\About</code></td>
205+
</tr>
206+
<tr>
207+
<td><code>Concerns\HasArtisan</code></td>
208+
<td><code>Concerns\Artisan</code></td>
209+
</tr>
210+
<tr>
211+
<td><code>Concerns\HasIsolatable</code></td>
212+
<td><code>Concerns\Isolatable</code></td>
213+
</tr>
214+
<tr>
215+
<td><code>Concerns\HasOptionable</code></td>
216+
<td><code>Concerns\Optionable</code></td>
217+
</tr>
218+
</table>
219+
</chapter>
220+
221+
<chapter title="Removed deprecated methods and properties" id="removed_deprecated_methods_and_properties">
222+
<p>
223+
The following properties and methods have been removed from the
224+
<code>DragonCode\LaravelDeployOperations\Operation</code>
225+
class:
226+
</p>
227+
228+
<table>
229+
<tr>
230+
<td>Removed</td>
231+
<td>Use Instead</td>
232+
</tr>
233+
<tr>
234+
<td><code>protected bool $once</code></td>
235+
<td><code>protected bool shouldOnce(): bool</code></td>
236+
</tr>
237+
<tr>
238+
<td><code>protected array|string|null $environment</code></td>
239+
<td><code>protected bool shouldRun(): bool</code></td>
240+
</tr>
241+
<tr>
242+
<td><code>protected array|string|null $exceptEnvironment</code></td>
243+
<td><code>protected bool shouldRun(): bool</code></td>
244+
</tr>
245+
<tr>
246+
<td><code>protected bool $before</code></td>
247+
<td><code>protected bool needBefore(): bool</code></td>
248+
</tr>
249+
<tr>
250+
<td><code>public function getConnection(): ?string</code></td>
251+
<td>Not used</td>
252+
</tr>
253+
<tr>
254+
<td><code>public function isOnce(): bool</code></td>
255+
<td><code>protected bool shouldOnce(): bool</code></td>
256+
</tr>
257+
<tr>
258+
<td><code>public function enabledTransactions(): bool</code></td>
259+
<td><code>public function withinTransactions(): bool</code></td>
260+
</tr>
261+
<tr>
262+
<td><code>public function transactionAttempts(): int</code></td>
263+
<td>It is indicated in the settings</td>
264+
</tr>
265+
<tr>
266+
<td><code>public function onEnvironment(): array</code></td>
267+
<td><code>protected bool shouldRun(): bool</code></td>
268+
</tr>
269+
<tr>
270+
<td><code>public function exceptEnvironment(): array</code></td>
271+
<td><code>protected bool shouldRun(): bool</code></td>
272+
</tr>
273+
<tr>
274+
<td><code>public function allow(): bool</code></td>
275+
<td><code>protected bool shouldRun(): bool</code></td>
276+
</tr>
277+
<tr>
278+
<td><code>public function hasBefore(): bool</code></td>
279+
<td><code>protected bool needBefore(): bool</code></td>
280+
</tr>
281+
<tr>
282+
<td><code>public function isAsync(): bool</code></td>
283+
<td><code>protected bool needAsync(): bool</code></td>
284+
</tr>
285+
</table>
286+
</chapter>
26287
</topic>

‎docs/writerside.cfg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
<snippets src="snippets" />
88

99
<instance src="do.tree" version="7.x" />
10+
<instance src="docs_libraries.tree" />
1011
</ihp>

0 commit comments

Comments
 (0)