Download deploy helper - deploy helper Source Code Download

deploy helper

Kode sumber lainnya

1.0.0

Unduh

Menyebarkan-Helper

Deploy-Helper adalah alat kecil untuk penyebaran artefak yang ditargetkan di pengembang perangkat lunak.

Daftar isi

Persyaratan
Tujuan
Kekurangan
Fitur
Konfigurasi
Placeholder / Variabel
Argumen
Instalasi
Cara menjalankan (contoh)
Membangun dari sumber
Berkontribusi

Persyaratan

Java 15!
OpenSsh (atau setara) untuk sesi SSH
- 'sshpass' jika Anda ingin menggunakan plaintext password auth

Tujuan

Saya menulis Deploy-Helper untuk membantu saya menggunakan artefak ke jaringan uji ketika saya sedang mengerjakan berbagai hal. Saya mungkin bisa menggunakan IDE saya untuk itu, tapi itu tidak menyenangkan!

Langkah Tanpa Penjelasan:

Menyusun
Buka File Explorer
Hapus artefak lama dari server
Seret dan letakkan artefak baru ke server

Langkah-langkah dengan Deploy-Helper:

Menyusun
Jalankan Deploy-Helper

Kekurangan

Itu ditulis dalam java
Itu tidak memiliki banyak fitur

Fitur

Beberapa tujuan penyebaran
Perintah lokal
Sesi SSH

Konfigurasi

File konfigurasi default deploy-helper.json harus berada di direktori kerja Anda.
Contoh Config:

 {
  // Required
  "destinations" : [
    {
      // Name of the destination
      "name" : "service1" ,
      // Normally you would set a real address or a ip here,
      // but you could also use aliases from your ssh config (like I did here)
      "address" : "test-network" ,
      // The path for our destination (used for the ssh session)
      "path" : "/home/user/services/service1/data/" ,
      // SSH_COMMANDS (ssh first, then commands) or 
      // COMMANDS_SSH (commands first, then ssh)
      "order" : "SSH_COMMANDS"
    } ,
    {
      "name" : "service2" ,
      "address" : "test-network" ,
      "path" : "/home/user/services/service1/data/" ,
      "order" : "SSH_COMMANDS"
    }
  ] ,
  // Required
  "artifact" : {
    // Directory that contains the artifact
    "directory" : "./target" ,
    // Name regex that matches the artifact
    "name" : "my-software-[\d.A-Za-z-]+\.jar" ,
    // Sorting operation for possible artifacts
    // LAST_MODIFIED_ASC (oldest file first) or
    // LAST_MODIFIED_DESC (newest file first)
    "sort" : "LAST_MODIFIED_DESC"
  } ,
  // Optional
  "commands" : [
    // Can be either a string or an array of strings
    "scp {ARTIFACT_PATH} {SSH_USER}@{DEST_ADDRESS}:{DEST_PATH}{ARTIFACT_NAME}"
  ] ,
  // Optional
  "ssh" : {
    // If port is > 0, the ssh command will be USER@HOST:PORT
    // If the port is <= 0, the ssh command will be USER@HOST
    "port" : 0 ,
    // How long to wait for the connection to establish
    "sleep" : "2000" ,
    // The ssh user
    "user" : "user" ,
    // Plaintext password auth requires 'sshpass'
    // "password": "foobar",
    "commands" : [
      // Commands have to be a string
      "rm my-software-*.jar"
    ]
  }
}

Contoh konfigurasi ini melakukan hal berikut:

Mulai sesi SSH
Jalankan perintah rm untuk menghapus artefak lama
Sesi SSH Keluar
Jalankan perintah scp untuk menyalin artefak baru ke server

Anda juga harus menambahkan deploy-helper.json ke file .gitignore Anda.

Catatan: Hanya ada satu artefak.

Placeholder / Variabel

{DEST_ADDRESS} : Alamat tujuan
{DEST_NAME} : Nama tujuan
{DEST_PATH} : jalur tujuan
{SSH_USER} : pengguna ssh
{SSH_PORT} : port ssh
{ARTIFACT_PATH} : jalur artefak
{ARTIFACT_NAME} : nama artefak

Argumen

Panjang	Pendek	Keterangan
-Config	-C	Mengesampingkan lokasi konfigurasi
--Verbose	-v	Jika diaktifkan output proses akan dialihkan ke stdout & stderr
--tujuan	-D	Mengesampingkan tujuan (daftar koma terpisah)

Instalasi

Menginstal Deploy-Helper semudah mengunduh toples dari rilis terbaru (dalam teori). Namun, Anda mungkin harus menjaga stoples di semacam lokasi pusat.

Beginilah cara saya 'menginstal' penyebaran-helper pada mesin Linux saya dengan zsh:

sudo mkdir /opt/deploy-helper
sudo chown max:max /opt/deploy-helper
mv ~/Downloads/deploy-helper-*.jar /opt/deploy-helper
echo "alias deploy='java --enable-preview -jar /opt/deploy-helper/deploy-helper-VERSION.jar'" >> ~/.zshrc

Kemudian cukup buka kembali terminal Anda (atau source ~/.zshrc ) dan Anda selesai!