airvzxf / airvzxf/ftp-deployment-action

docs(action.yml): top-level description says 'delete remote folder before' which is misleading

オープン 初心者向け
#199 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
audit documentation pending-human pending-review priority:medium
主要言語
Shell
スター
37
フォーク
9
平均マージ
44分
マージ済み PR(30日)
47

説明

gh issue create --title "docs(action.yml): top-level description says 'delete remote folder before' which is misleading" --label "documentation,audit,priority:medium" --body "## Finding

action.yml's top-level description claims the action 'deletes the remote folder before' uploading. The actual behaviour, controlled by `delete: INPUT_DELETE`, only deletes when INPUT_DELETE is true. The description misleads users into thinking deletion is unconditional.

## Affected code

- action.yml — top-level `description:` field

## Reproduction

N/A — text review.

## Suggested fix

Rewrite the top-level description to:

'Deploys files to an FTP/FTPS server using lftp. Supports delete-before-sync (controlled by INPUT_DELETE), glob exclude patterns, server-side concurrency lock, and per-attempt retries with exponential backoff.'

## Source

F2 audit 2026-09-03 (action.yml audit). Reporter: subagent-pekodbj7.

## Related

- Part of EPIC #[epic-number]
- Closes: #NONE (no existing issue)"

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

Read the top-level description in action.yml alongside the delete: INPUT_DELETE setting. Update the description so deletion is clearly conditional and still mentions FTP/FTPS deployment, glob excludes, concurrency locking, and retries; done when the wording matches the documented behavior.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions
領域
devops, documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
活発
明瞭さ
明確に書かれている
初心者へのやさしさ
90/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。