English | 中文

Steps to deploy a front-end project in a generic way when developing with a separate front-end and back-end：

1. Upload via Xshell command

2. Upload via filezilla visual interface

3. Script code is uploaded via ssh (you can configure your own business code)

4. Project configuration upload via Jenkins (associated git repository)

The above deployment method, there are shortcomings, but also need to compile in the input command, Jenkins configuration and complex, but also switch to other tools configuration, this extension is to replace the above tools, integrated into vscode, convenient for front-end developers to quickly integrate the deployment

Features

1. Automatically build and packaged projects

2. Automatic compression

3. Automatic upload server publishing

usage

1. Search for Woodpecker in the vscode extension and click install

2. Open File->Preferences->Settings

3. You can choose to go to the User Settings or Workspace Settings, find the Extension Tree node and locate Woodpecker, click Edit in Settings.json

4. Go to the Settings.json file and the following structure will be automatically generated for you

• Configuration of one server

{
    "name": "develop server", // Remarks of the server name
    "host": "127.0.0.1", // Server Address
    "username": "root", // Log in username
    "password": "password", // Log in password(Either password or privateKey)
    "privateKey":"Path to the private key of the certificate", //Path to the private key of the certificate(Either password or privateKey)
    "remotePath": "/home/www/admin", // The server file directory for project uploads
    "build": "yarn build:test", // Build the executed command
    "distPath": "dist" // The project is packed with directories that need to be uploaded
}

• If you have many servers, then you can also manage these servers in groups

[
    {
        "type": "group",
        "name": "group name",
        "children": [
            {
                "name": "develop server", // Remarks of the server name
                "host": "127.0.0.1", // Server Address
                "username": "root", // Log in username
                "password": "password", // Log in password(Either password or privateKey)
                "privateKey":"Path to the private key of the certificate", //Path to the private key of the certificate(Either password or privateKey)
                "remotePath": "/home/www/admin", // The server file directory for project uploads
                "build": "yarn build:test", // Build the executed command
                "distPath": "dist" // The project is packed with directories that need to be uploaded
            }
        ]
    },
    {
        "name": "develop server", // Remarks of the server name
        "host": "127.0.0.1", // Server Address
        "username": "root", // Log in username
        "password": "password", // Log in password(Either password or privateKey)
        "privateKey":"Path to the private key of the certificate", //Path to the private key of the certificate(Either password or privateKey)
        "remotePath": "/home/www/admin", // The server file directory for project uploads
        "build": "yarn build:test", // Build the executed command
        "distPath": "dist" // The project is packed with directories that need to be uploaded
    }
]

1. You can create multiple environments in the array configuration

2. Woodpecker creates two subgroups by default, one for the current workspace's servers (showing only current workspace's settings.json configuration) and one for the global server group (showing the user's settings.json)

FAQ

Do I need to configure both password and privateKey?

No, if you configure the address path of the key, then you don't need a username and password, otherwise you need a username and password

Is there any limitation of local development environment and server development environment?

Currently only in the local is window environment, the server is linux environment tested, other environments have not been tested, if there are problems, you can raise issues