Skip to content

Commit 657b133

Browse files
authored
docs: fix formatting in readme, don't run tests for changes in markdown (#56)
1 parent 100266d commit 657b133

File tree

2 files changed

+43
-42
lines changed

2 files changed

+43
-42
lines changed

.github/workflows/main.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@ name: tests
22

33
on:
44
pull_request:
5-
merge_group:
6-
types: [checks_requested]
5+
paths-ignore:
6+
- "**.md"
77
push:
8-
branches:
9-
- 'main'
8+
branches: [ main ]
9+
paths-ignore:
10+
- "**.md"
1011
workflow_dispatch:
1112
schedule:
1213
- cron: 0 0 * * *

README.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
test:
2121
runs-on: ubuntu-latest
2222
steps:
23-
- uses: actions/checkout@v1
23+
- uses: actions/checkout@v5
2424
- name: Setup DDEV
2525
uses: ddev/github-action-setup-ddev@v1
2626

@@ -41,8 +41,8 @@ jobs:
4141

4242
# use different PHP version in a test matrix
4343
- run: |
44-
sed -i -e 's/^php_version:.*/php_version: ${{ matrix.php-version }}/g' .ddev/config.yaml \
45-
&& ddev start
44+
sed -i -e 's/^php_version:.*/php_version: ${{ matrix.php-version }}/g' .ddev/config.yaml
45+
ddev start
4646
```
4747
4848
## Options
@@ -54,13 +54,13 @@ Path to your DDEV project. This path needs to contain the `.ddev/` directory.
5454
default: `.` (root directory)
5555

5656
```yaml
57-
- name: Setup DDEV
58-
uses: ddev/github-action-setup-ddev@v1
59-
with:
60-
ddevDir: ".devbox"
61-
- name: 'You need to switch to that directory to use the `ddev` command'
62-
run: ddev composer install
63-
working-directory: .devbox
57+
- name: Setup DDEV
58+
uses: ddev/github-action-setup-ddev@v1
59+
with:
60+
ddevDir: ".devbox"
61+
- name: 'You need to switch to that directory to use the `ddev` command'
62+
run: ddev composer install
63+
working-directory: .devbox
6464
```
6565
6666
### autostart
@@ -70,9 +70,9 @@ Starts your DDEV project immediately.
7070
default: `true`
7171

7272
```yaml
73-
- uses: ddev/github-action-setup-ddev@v1
74-
with:
75-
autostart: false
73+
- uses: ddev/github-action-setup-ddev@v1
74+
with:
75+
autostart: false
7676
```
7777

7878
### version
@@ -82,9 +82,9 @@ Install a specific ddev version. The version must be available in ddev's apt rep
8282
default: `latest`
8383

8484
```yaml
85-
- uses: ddev/github-action-setup-ddev@v1
86-
with:
87-
version: 1.24.7
85+
- uses: ddev/github-action-setup-ddev@v1
86+
with:
87+
version: 1.24.7
8888
```
8989

9090
### installScriptUrl
@@ -93,10 +93,10 @@ URL to the DDEV installation script. This allows you to specify a custom or alte
9393

9494
default: `https://ddev.com/install.sh`
9595

96-
```
97-
- uses: ddev/github-action-setup-ddev@v1
98-
with:
99-
installScriptUrl: "https://raw.githubusercontent.com/ddev/ddev/v1.22.4/scripts/install_ddev.sh"
96+
```yaml
97+
- uses: ddev/github-action-setup-ddev@v1
98+
with:
99+
installScriptUrl: "https://raw.githubusercontent.com/ddev/ddev/v1.22.4/scripts/install_ddev.sh"
100100
```
101101

102102
This option is useful for:
@@ -107,12 +107,12 @@ This option is useful for:
107107

108108
Example with custom script source:
109109

110-
```
111-
- name: Setup DDEV with custom installation script
112-
uses: ddev/github-action-setup-ddev@v1
113-
with:
114-
installScriptUrl: "https://my-company.com/scripts/custom_ddev_install.sh"
115-
version: "v1.24.7"
110+
```yaml
111+
- name: Setup DDEV with custom installation script
112+
uses: ddev/github-action-setup-ddev@v1
113+
with:
114+
installScriptUrl: "https://my-company.com/scripts/custom_ddev_install.sh"
115+
version: "v1.24.7"
116116
```
117117

118118
## Common recipes
@@ -122,18 +122,18 @@ Example with custom script source:
122122
If your workflow needs to reach remote destinations that require private SSH keys,
123123
we recommend adding SSH keys that you have entered as [GitHub "secrets"](https://docs.github.com/en/actions/security-guides/encrypted-secrets):
124124

125-
```
126-
- name: Setup SSH keys
127-
run: |
128-
mkdir -p .ddev/homeadditions/.ssh
129-
echo "${{ secrets.MY_KEY }}" > .ddev/homeadditions/.ssh/id_rsa
130-
chmod 700 .ddev/homeadditions/.ssh
131-
chmod 600 .ddev/homeadditions/.ssh/id_rsa
132-
- name 'optional: set up host keys'
133-
run: |
134-
echo "${{ secrets.MY_KNOWN_HOSTS }}" > .ddev/homeadditions/.ssh/known_hosts
135-
- name: Setup DDEV
136-
uses: ddev/github-action-setup-ddev@v1
125+
```yaml
126+
- name: Setup SSH keys
127+
run: |
128+
mkdir -p .ddev/homeadditions/.ssh
129+
echo "${{ secrets.MY_KEY }}" > .ddev/homeadditions/.ssh/id_rsa
130+
chmod 700 .ddev/homeadditions/.ssh
131+
chmod 600 .ddev/homeadditions/.ssh/id_rsa
132+
- name 'optional: set up host keys'
133+
run: |
134+
echo "${{ secrets.MY_KNOWN_HOSTS }}" > .ddev/homeadditions/.ssh/known_hosts
135+
- name: Setup DDEV
136+
uses: ddev/github-action-setup-ddev@v1
137137
```
138138

139139
## Contact

0 commit comments

Comments
 (0)