chore: refactor release process configuration

- Change the changelog configuration in `.goreleaser.yaml` from using GitHub to using git. Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
chore: refine goreleaser configuration and output
2026-06-16 14:49:25 +08:00 · 2024-04-02 15:58:52 +08:00 · 2024-04-02 14:57:44 +08:00 · 2024-04-02 14:10:03 +08:00 · 2024-03-16 13:00:11 +08:00 · 2024-03-16 12:58:52 +08:00
15 changed files with 299 additions and 169 deletions
@@ -13,12 +13,12 @@ name: "CodeQL"

 on:
  push:
-    branches: [ master ]
+    branches: [master]
  pull_request:
    # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [master]
  schedule:
-    - cron: '41 23 * * 6'
+    - cron: "41 23 * * 6"

 jobs:
  analyze:
@@ -32,23 +32,23 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        language: [ 'go' ]
+        language: ["go"]
        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
        # Learn more about CodeQL language support at https://git.io/codeql-language-support

    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v4

-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main

-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
@@ -5,54 +5,50 @@ on:
    branches:
      - master
    tags:
-      - 'v*'
+      - "v*"
  pull_request:
    branches:
-      - 'master'
+      - "master"

 jobs:
  build-docker:
    runs-on: ubuntu-latest
    steps:
-      - name: Setup go
-        uses: actions/setup-go@v4
-        with:
-          go-version: '^1'
      - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Setup go
+        uses: actions/setup-go@v5
        with:
-          fetch-depth: 0
+          go-version-file: go.mod
+          check-latest: true

      - name: Build binary
-        run : |
+        run: |
          make build_linux_amd64
          make build_linux_arm
          make build_linux_arm64
-      -
-        name: Set up QEMU
+
+      - name: Set up QEMU
        uses: docker/setup-qemu-action@v2

-      -
-        name: Set up Docker Buildx
+      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2

-      -
-        name: Login to Docker Hub
+      - name: Login to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

-      -
-        name: Login to GitHub Container Registry
+      - name: Login to GitHub Container Registry
        uses: docker/login-action@v2
        with:
          registry: ghcr.io
          username: ${{ github.repository_owner }}
          password: ${{ secrets.GITHUB_TOKEN }}

-      -
-        name: Docker meta
+      - name: Docker meta
        id: docker-meta
        uses: docker/metadata-action@v4
        with:
@@ -65,8 +61,7 @@ jobs:
            type=semver,pattern={{major}}.{{minor}}
            type=semver,pattern={{major}}

-      -
-        name: Build and push
+      - name: Build and push
        uses: docker/build-push-action@v4
        with:
          context: .
@@ -3,7 +3,7 @@ name: Goreleaser
 on:
  push:
    tags:
-      - '*'
+      - "*"

 permissions:
  contents: write
@@ -12,24 +12,21 @@ jobs:
  goreleaser:
    runs-on: ubuntu-latest
    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      -
-        name: Setup go
-        uses: actions/setup-go@v4
-        with:
-          go-version: '^1'
+      - name: Checkout repository
+        uses: actions/checkout@v4

-      -
-        name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v4
+      - name: Setup go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+          check-latest: true
+
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v5
        with:
          # either 'goreleaser' (default) or 'goreleaser-pro'
          distribution: goreleaser
          version: latest
-          args: release --rm-dist
+          args: release --clean
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -8,14 +8,17 @@ jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
-      - name: Setup go
-        uses: actions/setup-go@v4
-        with:
-          go-version: '^1'
      - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Setup go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+          check-latest: true
+
      - name: Setup golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
        with:
          version: latest
          args: --verbose
@@ -27,14 +30,16 @@ jobs:

  testing:
    runs-on: ubuntu-latest
-    container: golang:1.19-alpine
+    container:
+      image: golang:1.21-alpine
+      options: --sysctl net.ipv6.conf.all.disable_ipv6=0
    steps:
      - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4

      - name: setup sshd server
        run: |
-          apk add git make curl perl bash build-base zlib-dev ucl-dev
+          apk add git make curl perl bash build-base zlib-dev ucl-dev sudo
          make ssh-server

      - name: testing
@@ -42,4 +47,4 @@ jobs:
          make test

      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
@@ -3,78 +3,78 @@ before:
    - go mod tidy

 builds:
- env:
-  - CGO_ENABLED=0
-  goos:
-  - darwin
-  - linux
-  - windows
-  - freebsd
-  goarch:
-  - amd64
-  - arm
-  - arm64
-  goarm:
-  - "5"
-  - "6"
-  - "7"
-  ignore:
-    - goos: darwin
-      goarch: arm
-    - goos: darwin
-      goarch: ppc64le
-    - goos: darwin
-      goarch: s390x
-    - goos: windows
-      goarch: ppc64le
-    - goos: windows
-      goarch: s390x
-    - goos: windows
-      goarch: arm
-      goarm: "5"
-    - goos: windows
-      goarch: arm
-      goarm: "6"
-    - goos: windows
-      goarch: arm
-      goarm: "7"
-    - goos: windows
-      goarch: arm64
-    - goos: freebsd
-      goarch: ppc64le
-    - goos: freebsd
-      goarch: s390x
-    - goos: freebsd
-      goarch: arm
-      goarm: "5"
-    - goos: freebsd
-      goarch: arm
-      goarm: "6"
-    - goos: freebsd
-      goarch: arm
-      goarm: "7"
-    - goos: freebsd
-      goarch: arm64
-  flags:
-  - -trimpath
-  ldflags:
-  - -s -w
-  - -X main.Version={{.Version}}
-  binary: >-
-    {{ .ProjectName }}-
-    {{- if .IsSnapshot }}{{ .Branch }}-
-    {{- else }}{{- .Version }}-{{ end }}
-    {{- .Os }}-
-    {{- if eq .Arch "amd64" }}amd64
-    {{- else if eq .Arch "amd64_v1" }}amd64
-    {{- else if eq .Arch "386" }}386
-    {{- else }}{{ .Arch }}{{ end }}
-    {{- if .Arm }}-{{ .Arm }}{{ end }}
-  no_unique_dist_dir: true
-  hooks:
-    post:
-      - cmd: xz -k -9 {{ .Path }}
-        dir: ./dist/
+  - env:
+      - CGO_ENABLED=0
+    goos:
+      - darwin
+      - linux
+      - windows
+      - freebsd
+    goarch:
+      - amd64
+      - arm
+      - arm64
+    goarm:
+      - "5"
+      - "6"
+      - "7"
+    ignore:
+      - goos: darwin
+        goarch: arm
+      - goos: darwin
+        goarch: ppc64le
+      - goos: darwin
+        goarch: s390x
+      - goos: windows
+        goarch: ppc64le
+      - goos: windows
+        goarch: s390x
+      - goos: windows
+        goarch: arm
+        goarm: "5"
+      - goos: windows
+        goarch: arm
+        goarm: "6"
+      - goos: windows
+        goarch: arm
+        goarm: "7"
+      - goos: windows
+        goarch: arm64
+      - goos: freebsd
+        goarch: ppc64le
+      - goos: freebsd
+        goarch: s390x
+      - goos: freebsd
+        goarch: arm
+        goarm: "5"
+      - goos: freebsd
+        goarch: arm
+        goarm: "6"
+      - goos: freebsd
+        goarch: arm
+        goarm: "7"
+      - goos: freebsd
+        goarch: arm64
+    flags:
+      - -trimpath
+    ldflags:
+      - -s -w
+      - -X main.Version={{.Version}}
+    binary: >-
+      {{ .ProjectName }}-
+      {{- if .IsSnapshot }}{{ .Branch }}-
+      {{- else }}{{- .Version }}-{{ end }}
+      {{- .Os }}-
+      {{- if eq .Arch "amd64" }}amd64
+      {{- else if eq .Arch "amd64_v1" }}amd64
+      {{- else if eq .Arch "386" }}386
+      {{- else }}{{ .Arch }}{{ end }}
+      {{- if .Arm }}-{{ .Arm }}{{ end }}
+    no_unique_dist_dir: true
+    hooks:
+      post:
+        - cmd: xz -k -9 {{ .Path }}
+          dir: ./dist/

 archives:
  - format: binary
@@ -82,9 +82,9 @@ archives:
    allow_different_binary_count: true

 checksum:
-  name_template: 'checksums.txt'
+  name_template: "checksums.txt"
  extra_files:
-      - glob: ./**.xz
+    - glob: ./**.xz

 snapshot:
  name_template: "{{ incpatch .Version }}"
@@ -97,3 +97,21 @@ release:
  # Templates: allowed
  extra_files:
    - glob: ./**.xz
+
+changelog:
+  use: git
+  groups:
+    - title: Features
+      regexp: "^.*feat[(\\w)]*:+.*$"
+      order: 0
+    - title: "Bug fixes"
+      regexp: "^.*fix[(\\w)]*:+.*$"
+      order: 1
+    - title: "Enhancements"
+      regexp: "^.*chore[(\\w)]*:+.*$"
+      order: 2
+    - title: "Refactor"
+      regexp: "^.*refactor[(\\w)]*:+.*$"
+      order: 3
+    - title: Others
+      order: 999
@@ -0,0 +1,3 @@
+ignored:
+  - DL3018
+  - DL3008
@@ -104,10 +104,21 @@ ssh-server:
 	cat tests/.ssh/test.pub >> /home/drone-scp/.ssh/authorized_keys
 	chmod 600 /home/drone-scp/.ssh/authorized_keys
 	chown -R drone-scp /home/drone-scp/.ssh
+	# add public key to root user
+	mkdir -p /root/.ssh
+	chmod 700 /root/.ssh
+	cat tests/.ssh/id_rsa.pub >> /root/.ssh/authorized_keys
+	cat tests/.ssh/test.pub >> /root/.ssh/authorized_keys
+	chmod 600 /root/.ssh/authorized_keys
+	# Append the following entry to run ALL command without a password for a user named drone-scp:
+	cat tests/sudoers >> /etc/sudoers.d/sudoers
+	# install ssh and start server
 	apk add --update openssh openrc
 	rm -rf /etc/ssh/ssh_host_rsa_key /etc/ssh/ssh_host_dsa_key
 	sed -i 's/^#PubkeyAuthentication yes/PubkeyAuthentication yes/g' /etc/ssh/sshd_config
 	sed -i 's/AllowTcpForwarding no/AllowTcpForwarding yes/g' /etc/ssh/sshd_config
+	sed -i 's/^#ListenAddress 0.0.0.0/ListenAddress 0.0.0.0/g' /etc/ssh/sshd_config
+	sed -i 's/^#ListenAddress ::/ListenAddress ::/g' /etc/ssh/sshd_config
 	./tests/entrypoint.sh /usr/sbin/sshd -D &

 coverage:
@@ -4,7 +4,7 @@

 [![GitHub tag](https://img.shields.io/github/tag/appleboy/drone-ssh.svg)](https://github.com/appleboy/drone-ssh/releases)
 [![GoDoc](https://godoc.org/github.com/appleboy/drone-ssh?status.svg)](https://godoc.org/github.com/appleboy/drone-ssh)
-[![Lint and Testing](https://github.com/appleboy/drone-ssh/actions/workflows/lint.yml/badge.svg)](https://github.com/appleboy/drone-ssh/actions/workflows/lint.yml)
+[![Lint and Testing](https://github.com/appleboy/drone-ssh/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/appleboy/drone-ssh/actions/workflows/testing.yml)
 [![codecov](https://codecov.io/gh/appleboy/drone-ssh/branch/master/graph/badge.svg)](https://codecov.io/gh/appleboy/drone-ssh)
 [![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/drone-ssh)](https://goreportcard.com/report/github.com/appleboy/drone-ssh)
 [![Docker Pulls](https://img.shields.io/docker/pulls/appleboy/drone-ssh.svg)](https://hub.docker.com/r/appleboy/drone-ssh/)
@@ -12,9 +12,26 @@ LABEL org.opencontainers.image.source=https://github.com/appleboy/drone-ssh
 LABEL org.opencontainers.image.description="Execute commands on a remote host through SSH"
 LABEL org.opencontainers.image.licenses=MIT

-RUN apk add --no-cache ca-certificates=20230506-r0 && \
+RUN apk add --no-cache ca-certificates && \
  rm -rf /var/cache/apk/*

+RUN addgroup \
+  -S -g 1000 \
+  deploy && \
+  adduser \
+  -S -H -D \
+  -h /home/deploy \
+  -s /bin/sh \
+  -u 1000 \
+  -G deploy \
+  deploy
+
+RUN mkdir -p /home/deploy && \
+  chown deploy:deploy /home/deploy
+
+# deploy:deploy
+USER 1000:1000
+
 COPY release/${TARGETOS}/${TARGETARCH}/drone-ssh /bin/

 ENTRYPOINT ["/bin/drone-ssh"]
@@ -3,21 +3,21 @@ module github.com/appleboy/drone-ssh
 go 1.18

 require (
-	github.com/appleboy/easyssh-proxy v1.4.0
+	github.com/appleboy/easyssh-proxy v1.5.0
 	github.com/joho/godotenv v1.5.1
 	github.com/stretchr/testify v1.8.4
-	github.com/urfave/cli/v2 v2.25.7
-	golang.org/x/crypto v0.10.0
+	github.com/urfave/cli/v2 v2.27.1
+	golang.org/x/crypto v0.18.0
 )

 require (
 	github.com/ScaleFT/sshkeys v1.2.0 // indirect
-	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.3 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dchest/bcrypt_pbkdf v0.0.0-20150205184540-83f37f9c154a // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
-	golang.org/x/sys v0.9.0 // indirect
+	github.com/xrash/smetrics v0.0.0-20231213231151-1d8dd44e695e // indirect
+	golang.org/x/sys v0.16.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
@@ -1,9 +1,9 @@
 github.com/ScaleFT/sshkeys v1.2.0 h1:5BRp6rTVIhJzXT3VcUQrKgXR8zWA3sOsNeuyW15WUA8=
 github.com/ScaleFT/sshkeys v1.2.0/go.mod h1:gxOHeajFfvGQh/fxlC8oOKBe23xnnJTif00IFFbiT+o=
-github.com/appleboy/easyssh-proxy v1.4.0 h1:1ZESTmHaQcM8/gAvauWipaT4cI3oO8Nf95TUaobshqE=
-github.com/appleboy/easyssh-proxy v1.4.0/go.mod h1:CBOkizsKxFFuSn2kthXCD/mXIUnZyb/nLbYtHLzvcfM=
-github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
-github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/appleboy/easyssh-proxy v1.5.0 h1:OYdSPvYQN3mhnsMH5I2OF1TgwSEcSq33kvjQfTwvZww=
+github.com/appleboy/easyssh-proxy v1.5.0/go.mod h1:zcEMrStH91/tcUn3gUGP0KpQwUYLm8tX/Ook1AH98uc=
+github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0qnXZOBM=
+github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -19,21 +19,21 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/urfave/cli/v2 v2.25.7 h1:VAzn5oq403l5pHjc4OhD54+XGO9cdKVL/7lDjF+iKUs=
-github.com/urfave/cli/v2 v2.25.7/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
-github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
-github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
+github.com/urfave/cli/v2 v2.27.1 h1:8xSQ6szndafKVRmfyeUMxkNUJQMjL1F2zmsZ+qHpfho=
+github.com/urfave/cli/v2 v2.27.1/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
+github.com/xrash/smetrics v0.0.0-20231213231151-1d8dd44e695e h1:+SOyEddqYF09QP7vr7CgJ1eti3pY9Fn3LHO1M1r/0sI=
+github.com/xrash/smetrics v0.0.0-20231213231151-1d8dd44e695e/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.10.0 h1:LKqV2xt9+kDzSTfOhx4FrkEBcMrAgHSYgzywV9zcGmM=
-golang.org/x/crypto v0.10.0/go.mod h1:o4eNf7Ede1fv+hwOwZsTHl9EsPFO6q6ZvYR8vYfY45I=
+golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc=
+golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200219091948-cb0a6d8edb6c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.9.0 h1:KS/R3tvhPqvJvwcKfnBHJwwthS11LRhmM5D59eEXa0s=
-golang.org/x/sys v0.9.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.9.0 h1:GRRCnKYhdQrD8kfRAdQ6Zcw1P0OcELxGLKJvtjVMZ28=
+golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
+golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.16.0 h1:m+B6fahuftsE9qjo0VWp2FW0mB3MTJvR0BaMQrq0pmE=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
@@ -38,11 +38,10 @@ func main() {
 	app.Version = Version
 	app.Flags = []cli.Flag{
 		&cli.StringSliceFlag{
-			Name:     "host",
-			Aliases:  []string{"H"},
-			Usage:    "connect to host",
-			EnvVars:  []string{"PLUGIN_HOST", "SSH_HOST", "INPUT_HOST"},
-			FilePath: ".host",
+			Name:    "host",
+			Aliases: []string{"H"},
+			Usage:   "connect to host",
+			EnvVars: []string{"PLUGIN_HOST", "SSH_HOST", "INPUT_HOST"},
 		},
 		&cli.IntFlag{
 			Name:    "port",
@@ -53,7 +52,7 @@ func main() {
 		},
 		&cli.StringFlag{
 			Name:    "protocol",
-			Usage:   "The IP protocol to use. Default to tcp (both IPv4 and IPv6).",
+			Usage:   "The IP protocol to use. Valid values are \"tcp\". \"tcp4\" or \"tcp6\". Default to tcp.",
 			EnvVars: []string{"PLUGIN_PROTOCOL", "SSH_PROTOCOL", "INPUT_PROTOCOL"},
 			Value:   "tcp",
 		},
@@ -149,8 +148,8 @@ func main() {
 		},
 		&cli.StringFlag{
 			Name:    "proxy.protocol",
-			Usage:   "The IP protocol to use for the proxy. Default to tcp (both IPv4 and IPv6).",
-			EnvVars: []string{"PLUGIN_PROTOCOL", "SSH_PROTOCOL", "INPUT_PROTOCOL"},
+			Usage:   "The IP protocol to use for the proxy. Valid values are \"tcp\". \"tcp4\" or \"tcp6\". Default to tcp.",
+			EnvVars: []string{"PLUGIN_PROXY_PROTOCOL", "SSH_PROXY_PROTOCOL", "INPUT_PROXY_PROTOCOL"},
 			Value:   "tcp",
 		},
 		&cli.StringFlag{
@@ -220,6 +219,11 @@ func main() {
 			Usage:   "pass all environment variable to shell script",
 			EnvVars: []string{"PLUGIN_ALLENVS", "INPUT_ALLENVS"},
 		},
+		&cli.BoolFlag{
+			Name:    "request-pty",
+			Usage:   "request a pseudo-terminal from the server",
+			EnvVars: []string{"PLUGIN_REQUEST_PTY", "INPUT_REQUEST_PTY"},
+		},
 	}

 	// Override a template
@@ -288,6 +292,7 @@ func run(c *cli.Context) error {
 			Ciphers:           c.StringSlice("ciphers"),
 			UseInsecureCipher: c.Bool("useInsecureCipher"),
 			AllEnvs:           c.Bool("allenvs"),
+			RequireTty:        c.Bool("request-pty"),
 			Proxy: easyssh.DefaultConfig{
 				Key:               c.String("proxy.ssh-key"),
 				KeyPath:           c.String("proxy.key-path"),
@@ -44,6 +44,7 @@ type (
 		UseInsecureCipher bool
 		EnvsFormat        string
 		AllEnvs           bool
+		RequireTty        bool
 	}

 	// Plugin structure
@@ -60,7 +61,9 @@ func escapeArg(arg string) string {
 func (p Plugin) hostPort(host string) (string, string) {
 	hosts := strings.Split(host, ":")
 	port := strconv.Itoa(p.Config.Port)
-	if len(hosts) > 1 {
+	if len(hosts) > 1 &&
+		(p.Config.Protocol == easyssh.PROTOCOL_TCP ||
+			p.Config.Protocol == easyssh.PROTOCOL_TCP4) {
 		host = hosts[0]
 		port = hosts[1]
 	}
@@ -85,6 +88,7 @@ func (p Plugin) exec(host string, wg *sync.WaitGroup, errChannel chan error) {
 		Ciphers:           p.Config.Ciphers,
 		Fingerprint:       p.Config.Fingerprint,
 		UseInsecureCipher: p.Config.UseInsecureCipher,
+		RequestPty:        p.Config.RequireTty,
 		Proxy: easyssh.DefaultConfig{
 			Server:            p.Config.Proxy.Server,
 			User:              p.Config.Proxy.User,
@@ -432,7 +432,6 @@ func getHostPublicKeyFile(keypath string) (ssh.PublicKey, error) {
 	}

 	pubkey, _, _, _, err = ssh.ParseAuthorizedKey(buf)
-
 	if err != nil {
 		return nil, err
 	}
@@ -797,7 +796,8 @@ func TestPlugin_hostPort(t *testing.T) {
 			name: "different port",
 			fields: fields{
 				Config: Config{
-					Port: 22,
+					Port:     22,
+					Protocol: easyssh.PROTOCOL_TCP4,
 				},
 			},
 			args: args{
@@ -806,6 +806,20 @@ func TestPlugin_hostPort(t *testing.T) {
 			wantHost: "localhost",
 			wantPort: "443",
 		},
+		{
+			name: "ipv6",
+			fields: fields{
+				Config: Config{
+					Port:     22,
+					Protocol: easyssh.PROTOCOL_TCP6,
+				},
+			},
+			args: args{
+				h: "::1",
+			},
+			wantHost: "::1",
+			wantPort: "22",
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -919,3 +933,62 @@ out: [foobar]

 	assert.Equal(t, unindent(expected), unindent(buffer.String()))
 }
+
+func TestSudoCommand(t *testing.T) {
+	var (
+		buffer   bytes.Buffer
+		expected = `
+			======CMD======
+			sudo su - -c "whoami"
+			======END======
+			out: root
+		`
+	)
+
+	plugin := Plugin{
+		Config: Config{
+			Host:     []string{"localhost"},
+			Username: "drone-scp",
+			Port:     22,
+			KeyPath:  "./tests/.ssh/id_rsa",
+			Script: []string{
+				`sudo su - -c "whoami"`,
+			},
+			CommandTimeout: 10 * time.Second,
+			RequireTty:     true,
+		},
+		Writer: &buffer,
+	}
+
+	assert.Nil(t, plugin.Exec())
+	assert.Equal(t, unindent(expected), unindent(buffer.String()))
+}
+
+func TestCommandWithIPv6(t *testing.T) {
+	var (
+		buffer   bytes.Buffer
+		expected = `
+			======CMD======
+			whoami
+			======END======
+			out: drone-scp
+		`
+	)
+
+	plugin := Plugin{
+		Config: Config{
+			Host:     []string{"::1"},
+			Username: "drone-scp",
+			Port:     22,
+			KeyPath:  "./tests/.ssh/id_rsa",
+			Script: []string{
+				"whoami",
+			},
+			Protocol:       easyssh.PROTOCOL_TCP6,
+			CommandTimeout: 10 * time.Second,
+		},
+		Writer: &buffer,
+	}
+	assert.Nil(t, plugin.Exec())
+	assert.Equal(t, unindent(expected), unindent(buffer.String()))
+}
@@ -0,0 +1,2 @@
+Defaults        requiretty
+drone-scp ALL=(ALL) NOPASSWD:ALL
Author	SHA1	Message	Date
Bo-Yi Wu	e8a39a16a6	chore: refactor release process configuration - Change the changelog configuration in `.goreleaser.yaml` from using GitHub to using git. Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-02 15:58:52 +08:00
Bo-Yi Wu	f8b1db2997	chore: refine goreleaser configuration and output - Change the name template in `.goreleaser.yaml` from single to double quotes - Add a changelog configuration to `.goreleaser.yaml` with categorized groups for features, bug fixes, enhancements, refactor, and others Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-02 14:57:44 +08:00
Bo-Yi Wu	f37c5b3557	ci: refactor CI workflows and update actions - Update GitHub Actions to use newer versions (checkout to v4, codeql-action to v3, setup-go to v5, goreleaser-action to v5, golangci-lint-action to v4, codecov-action to v4) - Remove specific Go version pinning in favor of using the version specified in go.mod - Enable checking for the latest Go version in setup-go action - Replace `release --rm-dist` argument with `release --clean` in goreleaser action - Reorder steps and remove redundant checkout step in testing workflow Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-02 14:10:03 +08:00
appleboy	2c5e17dd2e	docs: update badge Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-03-16 13:00:11 +08:00
appleboy	42f9adb1b5	test: rename the workflow	2024-03-16 12:58:52 +08:00
Bo-Yi Wu	cafc139713	test: enhance testing and internal API robustness (#269 ) * test: support ipv6 * chore: update Signed-off-by: appleboy <appleboy.tw@gmail.com> * chore: update Signed-off-by: appleboy <appleboy.tw@gmail.com> --------- Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-03-16 11:29:44 +08:00
appleboy	7d0a886109	refactor: remove unnecessary line setting FilePath field to .host - Remove the line that sets the `FilePath` field to `.host` Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-01-27 11:22:04 +08:00
Bo-Yi Wu	a83bebeafe	refactor: refactor environment variable naming - Rename environment variables to include `_PROXY_` in their names Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-21 09:35:37 +08:00
Bo-Yi Wu	a41d4afc40	chore(protocol): improve IPv6 address. (#268 ) * docs: improve documentation and configuration handling - Clarify valid values for the IP protocol in usage messages for both main application and proxy settings Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * test: improve IPv6 command execution tests - Add a new test function `TestCommandWithIPv6` to check command execution with an IPv6 address - Initialize test variables and expected output for the IPv6 command test - Set up a `Plugin` struct with IPv6 host, user, port, key path, script, and command timeout for testing - Verify that `plugin.Exec()` returns `nil` (no error) in the IPv6 test - Assert that the output of the command execution matches the expected output in the IPv6 test Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * test: enhance test suite and CI robustness - Add support for IPv6 protocol in `TestCommandWithIPv6` test case in `plugin_test.go` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update2 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update3 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update4 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update5 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update5 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update5 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> --------- Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-21 09:27:49 +08:00
Bo-Yi Wu	91fd4f8071	chore: update golang.org/x/crypto to v0.18.0 in go.mod file - Update golang.org/x/crypto from v0.17.0 to v0.18.0 in the go.mod file Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-11 20:53:31 +08:00
Bo-Yi Wu	b34fffdbd3	feat: update plugin functionality in main.go and plugin.go files - Add a new flag to the main.go file - Add a new field to the Plugin type in the plugin.go file - Remove two lines from the plugin_test.go file Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-07 17:44:54 +08:00
Bo-Yi Wu	d217773bac	test: increase test coverage for SudoCommand function - Add a test for the SudoCommand function Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-07 17:40:23 +08:00
Bo-Yi Wu	ae023d7aa6	chore: update sudoers file for improved security and permissions management - Add `requiretty` to the `Defaults` in sudoers - Allow `drone-scp` to run commands without password prompt Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-07 17:21:59 +08:00
Bo-Yi Wu	222545746b	chore: refactor build and deployment processes - Add `sudo` to the apk add command in the lint workflow - Add SSH server setup to the Makefile Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-07 17:13:16 +08:00
Bo-Yi Wu	a5f89304fd	chore: update golang.org/x/sys to v0.16.0 in go.mod file - Update the version of `golang.org/x/sys` from `v0.15.0` to `v0.16.0` in the `go.mod` file Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-07 13:38:54 +08:00
Bo-Yi Wu	a9cfc0c134	chore: update external dependencies to latest versions - Update the version of `github.com/appleboy/easyssh-proxy` from `v1.4.1-0.20231106031702-5666e2ea5156` to `v1.5.0` - Update the version of `github.com/urfave/cli/v2` from `v2.26.0` to `v2.27.1` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-01-01 13:53:45 +08:00
Bo-Yi Wu	13ba21acf6	chore: update dependencies to latest versions - Update `github.com/urfave/cli` dependency from `v2.25.7` to `v2.26.0` - Upgrade `golang.org/x/crypto` from `v0.14.0` to `v0.17.0` - Bump `github.com/cpuguy83/go-md2man` from `v2.0.2` to `v2.0.3` - Update `github.com/xrash/smetrics` to a newer commit - Update `golang.org/x/sys` from `v0.14.0` to `v0.15.0` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2023-12-26 13:33:32 +08:00
Bo-Yi Wu	e270b033d1	ci: update dependencies and workflows - Update the Golang version in the lint workflow from `1.19-alpine` to `1.21-alpine` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2023-12-26 13:29:44 +08:00
Bo-Yi Wu	aa9314a009	chore: add default user for enhanced security (#267 ) - Add a new `.hadolint.yaml` configuration file with specific rule ignores - Update the Dockerfile to install `ca-certificates` without a fixed version - Add commands to create a `deploy` user and group with UID and GID `1000`, set home directory, and set ownership - Set the Docker container to run as the `deploy` user with UID and GID `1000` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2023-12-26 13:29:22 +08:00
Bo-Yi Wu	037e0231ac	chore: update dependencies to latest versions - Update the `go-version` in the lint.yml file from `^1` to `^1.21` - Update the version of `github.com/appleboy/easyssh-proxy` in the go.mod file from `v1.4.0` to `v1.4.1-0.20231106031702-5666e2ea5156` - Update the version of `golang.org/x/crypto` in the go.mod file from `v0.10.0` to `v0.14.0` - Update the version of `golang.org/x/sys` in the go.mod file from `v0.9.0` to `v0.14.0` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2023-11-06 11:20:51 +08:00
Bo-Yi Wu	ddf1b161aa	chore: refactor GitHub Actions workflows - Fix a typo in the cron expression for the codeql.yml workflow - Change the language specification from ['go'] to ['go'] in the codeql.yml workflow - Change the version specification from 'v' to 'v' in the docker.yml workflow - Change the branch specification from 'master' to 'master' in the docker.yml workflow - Change the go-version specification from '^1' to '^1.21' in the docker.yml workflow - Remove the name "Set up QEMU" in the docker.yml workflow - Remove the name "Set up Docker Buildx" in the docker.yml workflow - Remove the name "Login to Docker Hub" in the docker.yml workflow - Remove the name "Login to GitHub Container Registry" in the docker.yml workflow - Remove the name "Docker meta" in the docker.yml workflow - Remove the name "Build and push" in the docker.yml workflow - Change the version specification from '' to '' in the goreleaser.yml workflow - Remove the name "Checkout" in the goreleaser.yml workflow - Remove the name "Setup go" in the goreleaser.yml workflow - Change the go-version specification from '^1' to '^1' in the goreleaser.yml workflow - Remove the name "Run GoReleaser" in the goreleaser.yml workflow - Change the go-version specification from '^1' to '^1' in the lint.yml workflow Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2023-10-25 10:52:46 +08:00