Skip to content

Commit f58afeb

Browse files
committed
Preparing plugin for release
1 parent 530b207 commit f58afeb

3 files changed

Lines changed: 30 additions & 32 deletions

File tree

CHANGELOG.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,24 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [1.0.0] - 2025-09-20
8+
## [1.0.0] - 2025-11-04
9+
910
### Added
10-
- Initial release of the **SyncOps Plugin**.
11-
- Features:
12-
- Support for Winter CMS.
13-
- Deployment of projects to remote servers via SSH and Git.
14-
- Remote database synchronization (pull from production to local).
15-
- Project backup and archive creation with timestamped filenames.
16-
- File and media synchronization between environments.
17-
- Configurable permissions handling for `root_user` and `web_user`.
18-
- Fully compatible with Winter CMS version `1.2.7`.
11+
- Initial release of the **NumenCode SyncOps Plugin** for **Winter CMS**.
12+
- Comprehensive DevOps toolkit for developers managing multiple environments.
13+
- Seamless **SSH** and **SFTP** integration for secure remote operations.
14+
- Automated **deployment** and **rollback** via Git on remote servers.
15+
- **Database synchronization** between local, staging, and production environments.
16+
- **Media file synchronization** using efficient SFTP transfers.
17+
- **Automated project backups** with configurable compression and timestamped filenames.
18+
- Support for **cloud storage uploads** (e.g. Dropbox) via Laravel’s filesystem.
19+
- Customizable **permissions management** (`root_user`, `web_user`, and `web_folders`).
20+
- Rich, developer-friendly **configuration** via `config/syncops.php`.
21+
- Fully compatible with **Winter CMS 1.2.8+** and **PHP 8.1+**.
1922

2023
---
2124

2225
### Links
23-
- GitHub repository: [wn-syncops-plugin](https://github.com/numencode/wn-syncops-plugin)
26+
- **GitHub:** [numencode/wn-syncops-plugin](https://github.com/numencode/wn-syncops-plugin)
27+
- **Packagist:** [packagist.org/packages/numencode/wn-syncops-plugin](https://packagist.org/packages/numencode/wn-syncops-plugin)
28+
- **Author:** [Blaž Oražem](https://orazem.si/)

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Run the command:
3636
php artisan vendor:publish --tag=syncops-config
3737
```
3838

39-
The above command will create a new configuration file, located at `/config/syncops.php`, that contains all the options
39+
This command will create a new configuration file, located at `/config/syncops.php`, that contains all the options
4040
you need in order to configure your remote connections. The connections array contains a list of your servers keyed
4141
by name. Simply populate the credentials in the connections array via your environment variables in the `.env` file.
4242

@@ -51,14 +51,14 @@ Each connection entry (e.g. `production`, `staging`) describes how SyncOps shoul
5151
'timestamp' => 'Y-m-d_H_i_s',
5252
```
5353

54-
Defines the default timestamp format used for naming files (backups, database dumps, archives).
54+
Defines the default timestamp format used for naming files (backups, database dumps, archives).
5555
Defaults to `Y-m-d_H_i_s`.
5656

5757
---
5858

5959
### Connections
6060

61-
All remote servers are defined under the `connections` array.
61+
All remote servers are defined under the `connections` array.
6262
Each server is keyed by a name (e.g. `production`, `staging`) and contains:
6363

6464
#### SSH Credentials
@@ -126,16 +126,16 @@ they are only required in your **local/dev environment** to allow SyncOps to con
126126

127127
## Commands overview
128128

129-
| Command | Description |
130-
|:------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------|
131-
| [syncops:db-pull](#db-pull) | Create a database dump on a remote server, download it, and import it locally. |
132-
| [syncops:db-push](#db-push) | Create a database dump (compressed by default) and optionally upload it to cloud storage. |
133-
| [syncops:media-pull](#media-pull) | Download media files from the remote server via SFTP into local storage. |
134-
| [syncops:media-push](#media-push) | Back up all media files to the specified cloud storage. |
135-
| [syncops:project-backup](#project-backup) | Create a compressed archive of project files and optionally upload it to cloud storage. |
136-
| [syncops:project-deploy](#project-deploy) | Deploy the project to a remote server via Git, with optional cache clearing, Composer install, and migrations. |
137-
| [syncops:project-pull](#project-pull) | Commit untracked changes on the remote server, push them to the origin, and optionally merge them into the local branch. |
138-
| [syncops:project-push](#project-push) | Add and commit project changes locally and push them to the remote repository. |
129+
| Command | Description |
130+
|:------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------|
131+
| [syncops:db-pull](#db-pull) | Create a database dump on a remote server,<br>download it, and import it locally. |
132+
| [syncops:db-push](#db-push) | Create a database dump (compressed by default)<br>and optionally upload it to cloud storage. |
133+
| [syncops:media-pull](#media-pull) | Download media files from the remote server<br>via SFTP into local storage. |
134+
| [syncops:media-push](#media-push) | Back up all media files<br>to the specified cloud storage. |
135+
| [syncops:project-backup](#project-backup) | Create a compressed archive of project files<br>and optionally upload it to cloud storage. |
136+
| [syncops:project-deploy](#project-deploy) | Deploy the project to a remote server via Git, with optional<br>cache clearing, Composer install, and migrations. |
137+
| [syncops:project-pull](#project-pull) | Commit untracked changes on the remote server, push them<br>to the origin, and optionally merge them into the local branch. |
138+
| [syncops:project-push](#project-push) | Add and commit project changes locally<br>and push them to the remote repository. |
139139

140140
---
141141

composer.json

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,13 @@
2020
"require": {
2121
"php": "^8.1",
2222
"winter/storm": "^1.2",
23-
"phpseclib/phpseclib": "^3.0",
24-
"composer/installers": "^2.2"
23+
"phpseclib/phpseclib": "^3.0"
2524
},
2625
"autoload": {
2726
"psr-4": {
2827
"NumenCode\\SyncOps\\": ""
2928
}
3029
},
31-
"config": {
32-
"allow-plugins": {
33-
"composer/installers": true
34-
},
35-
"sort-packages": true
36-
},
3730
"extra": {
3831
"installer-name": "syncops",
3932
"installer-type": "winter-plugin"

0 commit comments

Comments
 (0)