Skip to content

Commit 82ec4b1

Browse files
andrey-helldarandrey-helldar
committed
Documentation has been moved
1 parent 5b8ec2b commit 82ec4b1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+2265
-2
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
id-token: write
11+
pages: write
12+
13+
env:
14+
COMPOSER_TOKEN: ${{ secrets.COMPOSER_TOKEN }}
15+
ARTIFACT_DOCS: webHelpDO2-all.zip
16+
INSTANCE: docs/do
17+
DOMAIN_NAME: deploy-operations.dragon-code.pro
18+
BUILDER_VERSION: 2025.03.8312
19+
20+
jobs:
21+
build:
22+
name: Build application
23+
runs-on: ubuntu-latest
24+
25+
steps:
26+
- uses: actions/checkout@v4
27+
with:
28+
fetch-depth: 0
29+
30+
- name: Build documentation
31+
uses: JetBrains/writerside-github-action@v4
32+
with:
33+
instance: ${{ env.INSTANCE }}
34+
artifact: ${{ env.ARTIFACT_DOCS }}
35+
docker-version: ${{ env.BUILDER_VERSION }}
36+
37+
- name: Upload artifacts
38+
uses: actions/upload-artifact@v4
39+
with:
40+
name: docs
41+
path: |
42+
artifacts/${{ env.ARTIFACT_DOCS }}
43+
artifacts/report.json
44+
retention-days: 7
45+
46+
test:
47+
needs: build
48+
name: Testing
49+
runs-on: ubuntu-latest
50+
51+
steps:
52+
- name: Download docs artifact
53+
uses: actions/download-artifact@v4
54+
with:
55+
name: docs
56+
path: artifacts
57+
58+
- name: Test documentation
59+
uses: JetBrains/writerside-checker-action@v1
60+
with:
61+
instance: ${{ env.INSTANCE }}
62+
63+
robots:
64+
needs: build
65+
name: Generate robots.txt
66+
runs-on: ubuntu-latest
67+
68+
steps:
69+
- name: Create robots.txt
70+
run: |
71+
touch robots.txt
72+
echo "User-Agent: *" >> robots.txt
73+
echo "Disallow: " >> robots.txt
74+
echo "Host: https://${{ env.DOMAIN_NAME }}" >> robots.txt
75+
echo "Sitemap: https://${{ env.DOMAIN_NAME }}/sitemap.xml" >> robots.txt
76+
77+
- name: Upload artifacts
78+
uses: actions/upload-artifact@v4
79+
with:
80+
name: robots
81+
path: robots.txt
82+
retention-days: 7
83+
84+
deploy-pages:
85+
environment:
86+
name: deploy
87+
url: ${{ steps.deployment.outputs.page_url }}
88+
89+
needs:
90+
- test
91+
- robots
92+
93+
name: Deploy to pages
94+
runs-on: ubuntu-latest
95+
96+
steps:
97+
- name: Download docs artifact
98+
uses: actions/download-artifact@v4
99+
with:
100+
name: docs
101+
102+
- name: Download robots artifact
103+
uses: actions/download-artifact@v4
104+
with:
105+
name: robots
106+
107+
- name: Unzip artifact
108+
run: unzip -O UTF-8 -qq '${{ env.ARTIFACT_DOCS }}' -d dir
109+
110+
- name: Move robots
111+
run: |
112+
sudo mv robots.txt dir/robots.txt
113+
114+
- name: Setup Pages
115+
uses: actions/configure-pages@v5
116+
117+
- name: Upload artifact
118+
uses: actions/upload-pages-artifact@v3
119+
with:
120+
path: dir
121+
122+
- name: Deploy to GitHub Pages
123+
id: deployment
124+
uses: actions/deploy-pages@v4

‎docs/cfg/buildprofiles.xml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
3+
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
5+
6+
<variables>
7+
<generate-canonicals>true</generate-canonicals>
8+
<locale-code>en_US</locale-code>
9+
<!-- <header-logo>logo.svg</header-logo> -->
10+
<!-- <og-image> -->
11+
<!-- https://raw.githubusercontent.com/Laravel-Lang/docs/main/docs/images/social-logo.png -->
12+
<!-- </og-image> -->
13+
<web-root>https://deploy-operations.dragon-code.pro</web-root>
14+
<enable-contribution>true</enable-contribution>
15+
<contribute-url>
16+
https://github.com/TheDragonCode/laravel-deploy-operations/edit/main/docs/
17+
</contribute-url>
18+
<!-- <custom-favicons> -->
19+
<!-- favicon.svg,favicon.svg,favicon.svg,favicon.svg -->
20+
<!-- </custom-favicons> -->
21+
<!-- <analytics-head-script-file> -->
22+
<!-- analytics.html -->
23+
<!-- </analytics-head-script-file> -->
24+
</variables>
25+
<build-profile instance="do">
26+
<variables>
27+
<product-web-url>https://deploy-operations.dragon-code.pro/</product-web-url>
28+
<noindex-content>false</noindex-content>
29+
<!-- <og-image> -->
30+
<!-- https://raw.githubusercontent.com/TheDragonCode/laravel-deploy-operations/main/docs/images/social-logo.png -->
31+
<!-- </og-image> -->
32+
</variables>
33+
</build-profile>
34+
<sitemap priority="0.5" change-frequency="weekly" />
35+
<footer>
36+
<social type="github" href="https://github.com/TheDragonCode">
37+
GitHub
38+
</social>
39+
<link href="https://boosty.to/dragon-code">
40+
Boosty
41+
</link>
42+
<link href="https://github.com/TheDragonCode/laravel-deploy-operations/issues">
43+
Issues
44+
</link>
45+
</footer>
46+
</buildprofiles>

‎docs/do.tree‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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="do"
6+
name="🚀 Laravel Deploy Operations"
7+
start-page="introduction.topic">
8+
9+
<toc-element toc-title="Prologue">
10+
<toc-element topic="introduction.topic" />
11+
<toc-element toc-title="Upgrade Guide">
12+
<toc-element topic="upgrade-7.topic" toc-title="Upgrade to 7.x" />
13+
<toc-element topic="upgrade-6.topic" toc-title="Upgrade to 6.x" />
14+
<toc-element topic="upgrade-5.topic" toc-title="Upgrade to 5.x" />
15+
<toc-element topic="upgrade-4.topic" toc-title="Upgrade to 4.x" />
16+
<toc-element topic="upgrade-3.topic" toc-title="Upgrade to 3.x" />
17+
</toc-element>
18+
</toc-element>
19+
<toc-element toc-title="Getting Started">
20+
<toc-element topic="installation.topic" />
21+
<toc-element topic="usage.topic" />
22+
</toc-element>
23+
<toc-element toc-title="Guide">
24+
<toc-element topic="running-operations.topic" />
25+
<toc-element topic="creating-operations.topic" />
26+
<toc-element topic="rolling-back-operations.topic" />
27+
<toc-element topic="operations-status.topic" />
28+
<toc-element topic="customize-stub.topic" />
29+
</toc-element>
30+
<toc-element toc-title="Helpers">
31+
<toc-element topic="artisan-commands.topic" />
32+
<toc-element topic="events.topic" />
33+
<toc-element topic="execution-status.topic" />
34+
</toc-element>
35+
<toc-element toc-title="Extras">
36+
<toc-element topic="database-data-dumper.topic" />
37+
</toc-element>
38+
</instance-profile>

‎docs/images/.gitkeep‎

Whitespace-only changes.

‎docs/redirection-rules.xml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
3+
<rules>
4+
<!-- format is as follows
5+
<rule id="<unique id>">
6+
<accepts>page.html</accepts>
7+
</rule>
8+
-->
9+
<rule id="1bcc9e2a">
10+
<description>Created after removal of "About Deploy Operations" from Deploy Operations</description>
11+
<accepts>starter-topic.html</accepts>
12+
</rule>
13+
<rule id="33a6d1d0">
14+
<description>Created after removal of "Running Operations" from Deploy Operations</description>
15+
<accepts>guide-running-operations.html</accepts>
16+
</rule>
17+
<rule id="54ead075">
18+
<description>Created after removal of "Running operations" from Deploy Operations</description>
19+
<accepts>running-operations.html</accepts>
20+
</rule>
21+
<rule id="4195a4d">
22+
<description>Created after removal of "Creation Operations" from Deploy Operations</description>
23+
<accepts>creation-operations.html</accepts>
24+
</rule>
25+
<rule id="46593472">
26+
<description>Created after removal of "Operations Status" from Deploy Operations</description>
27+
<accepts>operations-status.html</accepts>
28+
</rule>
29+
<rule id="27586ab9">
30+
<description>Created after removal of "Helpers" from Deploy Operations</description>
31+
<accepts>Helpers.html</accepts>
32+
</rule>
33+
<rule id="3db5de6a">
34+
<description>Created after removal of "Rolling Back Operations" from Deploy Operations</description>
35+
<accepts>Rolling-Back-Operations.html</accepts>
36+
</rule>
37+
<rule id="702c2c89">
38+
<description>Created after removal of "Artisan Command" from Deploy Operations</description>
39+
<accepts>artisan-command.html</accepts>
40+
</rule>
41+
<rule id="61d0bb17">
42+
<description>Created after removal of "Events" from Deploy Operations</description>
43+
<accepts>events.html</accepts>
44+
</rule>
45+
<rule id="5ebc6059">
46+
<description>Created after removal of "Execution Status" from Deploy Operations</description>
47+
<accepts>execution-status.html</accepts>
48+
</rule>
49+
</rules>

‎docs/snippets/actual_file_names.sh‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# actual file names
2+
2022_10_14_000001_test1 # 1
3+
2022_10_14_000004_test4 # 4
4+
bar/2022_10_14_000003_test3 # 3
5+
foo/2022_10_14_000002_test2 # 2

‎docs/snippets/ask.sh‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
php artisan make:operation
2+
Creating an operation
3+
4+
┌ What should the operation be named? ─────────────────────────┐
5+
│ E.g. activate articles │
6+
└──────────────────────────────────────────────────────────────┘
7+
Press Enter to autodetect

‎docs/snippets/async.php‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use DragonCode\LaravelDeployOperations\Operation;
6+
7+
return new class extends Operation {
8+
public function __invoke()
9+
{
10+
// some
11+
}
12+
13+
public function shouldBeAsync(): bool
14+
{
15+
return true;
16+
}
17+
};

‎docs/snippets/before_after.sh‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
php artisan operations --before
2+
3+
# some commands
4+
5+
php artisan operations

‎docs/snippets/deployer.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
task('deploy', [
6+
// ...
7+
'artisan:migrate',
8+
'artisan:operation --before', // here
9+
'deploy:publish',
10+
'php-fpm:reload',
11+
'artisan:queue:restart',
12+
'artisan:operations', // here
13+
]);

0 commit comments

Comments
 (0)