Skip to content

Commit 3695ee6

Browse files
SamKirklandSamKirkland
committed
exclude git example update
1 parent ca38d85 commit 3695ee6

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

‎README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,21 @@ Keys can be added directly to your .yml config file or referenced from your proj
5555
To add a `secret` go to the `Settings` tab in your project then select `Secrets`.
5656
I strongly recommend you store your `password` as a secret.
5757

58-
| Key Name | Required | Example | Default Value | Description |
59-
|-------------------------|----------|----------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60-
| `server` | Yes | `ftp.samkirkland.com` | | Deployment destination server |
61-
| `username` | Yes | `[email protected]` | | FTP user name |
62-
| `password` | Yes | `CrazyUniquePassword&%123` | | FTP password, be sure to escape quotes and spaces |
63-
| `port` | No | `990` | `21` | Server port to connect to (read your web hosts docs) |
64-
| `protocol` | No | `ftps` | `ftp` | `ftp`: provides no encryption, `ftps`: full encryption newest standard (aka "explicit" ftps), `ftps-legacy`: full encryption legacy standard (aka "implicit" ftps) |
65-
| `local-dir` | No | `./myFolderToPublish/` | `./` | Folder to upload from, must end with trailing slash `/` |
66-
| `server-dir` | No | `public_html/www/` | `./` | Folder to upload to (on the server), must end with trailing slash `/` |
67-
| `state-name` | No | `folder/.sync-state.json` | `.ftp-deploy-sync-state.json` | Path and name of the state file - this file is used to track which files have been deployed |
68-
| `dry-run` | No | `true` | `false` | Prints which modifications will be made with current config options, but doesn't actually make any changes |
69-
| `dangerous-clean-slate` | No | `true` | `false` | Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument |
70-
| `exclude` | No | | `.git*` `.git*/**` `node_modules/**` `node_modules/**/*` | An array of glob patterns, these files will not be included in the publish/delete process. [List must be in yaml array format](#exclude-files) |
71-
| `log-level` | No | `minimal` | `standard` | `minimal`: only important info, `standard`: important info and basic file changes, `verbose`: print everything the script is doing |
72-
| `security` | No | `strict` | `loose` | `strict`: Reject any connection which is not authorized with the list of supplied CAs. `loose`: Allow connection even when the domain is not certificate |
58+
| Key Name | Required | Example | Default Value | Description |
59+
|-------------------------|----------|----------------------------|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60+
| `server` | Yes | `ftp.samkirkland.com` | | Deployment destination server |
61+
| `username` | Yes | `[email protected]` | | FTP user name |
62+
| `password` | Yes | `CrazyUniquePassword&%123` | | FTP password, be sure to escape quotes and spaces |
63+
| `port` | No | `990` | `21` | Server port to connect to (read your web hosts docs) |
64+
| `protocol` | No | `ftps` | `ftp` | `ftp`: provides no encryption, `ftps`: full encryption newest standard (aka "explicit" ftps), `ftps-legacy`: full encryption legacy standard (aka "implicit" ftps) |
65+
| `local-dir` | No | `./myFolderToPublish/` | `./` | Folder to upload from, must end with trailing slash `/` |
66+
| `server-dir` | No | `public_html/www/` | `./` | Folder to upload to (on the server), must end with trailing slash `/` |
67+
| `state-name` | No | `folder/.sync-state.json` | `.ftp-deploy-sync-state.json` | Path and name of the state file - this file is used to track which files have been deployed |
68+
| `dry-run` | No | `true` | `false` | Prints which modifications will be made with current config options, but doesn't actually make any changes |
69+
| `dangerous-clean-slate` | No | `true` | `false` | Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument |
70+
| `exclude` | No | | `.git*` `**.git*` `.git*/**` `**/.git*/**` `node_modules/**` `node_modules/**/*` | An array of glob patterns, these files will not be included in the publish/delete process. [List must be in yaml array format](#exclude-files) |
71+
| `log-level` | No | `minimal` | `standard` | `minimal`: only important info, `standard`: important info and basic file changes, `verbose`: print everything the script is doing |
72+
| `security` | No | `strict` | `loose` | `strict`: Reject any connection which is not authorized with the list of supplied CAs. `loose`: Allow connection even when the domain is not certificate |
7373

7474

7575
# Common Examples
@@ -169,6 +169,7 @@ jobs:
169169
username: myFtpUserName
170170
password: ${{ secrets.password }}
171171
exclude: .git*
172+
- **.git*
172173
- .git*/**
173174
- **/.git*/**
174175
- node_modules/**

0 commit comments

Comments
 (0)