Skip to content

Commit c15ea8f

Browse files
authored
Update migration.md (#389)
Improved pagination, add missing punctuation, delete useless separation lines, improve bullet lists, add link to README and releases page
1 parent 8a24039 commit c15ea8f

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

migration.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Migrating from v4.1.0 to v4.2.0
1+
# How to migrate between versions
22

3-
`v4.2.0` parses the `exclude` option in a more standard way.
3+
## Migrating from v4.1.0 to v4.2.0
4+
5+
`v4.2.0` parses the `exclude` option in a more standard way. Going forward the `exclude` option **must** be in the following format:
46

5-
Going forward the `exclude` option **must** be in the following format
67
```yml
78
exclude: |
89
**/.git*
@@ -11,28 +12,29 @@ exclude: |
1112
fileToExclude.txt
1213
```
1314
14-
---
15-
16-
# Migrating from v3 to v4
15+
## Migrating from v3 to v4
1716
1817
Migrating from v3 to v4 should be fairly straightforward. Version 4 was designed with speed and ease of initial setup in mind. Going forward version 4 will be the only supported version.
1918
20-
#### Those who can't upgrade
21-
Most features have been carried forward and improved upon. However, some features did not make the cut.
19+
### Those who can't upgrade
20+
21+
Most features have been carried forward and improved upon. However, some features did not make the cut:
2222
- **`sftp` is no longer supported**. If you have `sftp` access you are using `ssh`, that means you have access to a much more modern and capable protocol. I plan on releasing a separate github action that will deploy over `sftp`/`ssh` using `rsync`. Until then you can continue using version 3.
2323
- The `include` argument has been removed. I didn't see much need for it in the initial release. If you need this feature please create a support ticket.
2424

25-
---
26-
2725
### How to upgrade
2826

29-
1) Remove `with: fetch-depth: 2`. It is no longer needed and removing it will _slightly_ speed up deployments.
30-
2) Change the version to `4.X.X`, for example `SamKirkland/FTP-Deploy-Action@v4.3.4` (please check readme for latest version)
31-
3) If you have a `.git-ftp-include` file you should delete it. Version 4 tracks files differently and no longer needs this config file.
32-
4) If you have a `.git-ftp-ignore` file, you should transfer the options to the new `exclude` argument. _Note: Version 4 excludes any `.git*` and `node_modules/` files/folders by default_
33-
5) Update your arguments to reflect the following changes
34-
* `ftp-server` was split into 4 arguments. `server`, `port`, `protocol`, and `server-dir`. Transfer your config to these options as needed.
35-
* `ftp-username` was renamed to `username`
36-
* `ftp-password` was renamed to `password`
37-
* `local-dir` and `server-dir` now **must** end with `/`
38-
* `git-ftp-args` and `known-hosts` arguments were removed
27+
1. Remove `with: fetch-depth: 2`. It is no longer needed and removing it will _slightly_ speed up deployments.
28+
2. Change the version to `v4.X.X`, for example `SamKirkland/FTP-Deploy-Action@v4.3.4` (please check the [README](https://github.com/SamKirkland/FTP-Deploy-Action/blob/master/README.md) or the [releases page](https://github.com/SamKirkland/FTP-Deploy-Action/releases/latest) for the latest version).
29+
3. If you have a `.git-ftp-include` file you should delete it. Version 4 tracks files differently and no longer needs this config file.
30+
4. If you have a `.git-ftp-ignore` file, you should transfer the options to the new `exclude` argument. **Note:** version 4 excludes any `.git*` and `node_modules/` files / folders by default.
31+
5. Update your arguments to reflect the following changes:
32+
- `ftp-server` was split into 4 arguments:
33+
- `server`
34+
- `port`
35+
- `protocol`
36+
- `server-dir`
37+
- `ftp-username` was renamed to `username`.
38+
- `ftp-password` was renamed to `password`.
39+
- `local-dir` and `server-dir` now **must** end with `/`.
40+
- `git-ftp-args` and `known-hosts` arguments were removed.

0 commit comments

Comments
 (0)