Really poor documentation....?
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 28/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- azure, typescript
- 領域
- devops, documentation
調査の方向性
まず、issue に示されている MicrosoftSecurityDevOps@1 タスクの構成と wiki を確認します。これには、環境変数、カテゴリ、ツール、コマンド入力が含まれます。カテゴリとツールを使い分けるタイミング、Terrascan_IacDir などの変数の構成方法を文書化し、報告された失敗と正常な構成の両方を含む、検証済みの動作例を提示してください。
索引モデルが issue の本文から書いたものです。
説明
Almost nothing else to say, it's quite clear to anyone that hits this product and it's repo.
Let me explain why it is very disappointing its poor documentation considering that this a product cost money.
Few examples:
- where would be convenient to set the task to be executed? (first task, last one., somewhere in the middle?)
- Categories and/or tools, which one should be used and under which circunstancies?
- how to configure parameters as environment variables? the wiki page doesn't explain how to do it properly without breaking things, what the GDN_ (optional) prefix is intended for?
- how to use it?? e.g. :
- task: MicrosoftSecurityDevOps@1
displayName: Microsoft Security DevOps
env:
Terrascan_IacDir: '$(build.artifactstagingdirectory)/$(ENV)'
as per the documentation, this config should be correct? because it fails with the following error:
The target directory is not provided. Defaults to the working directory: /home/vsts/work/1/s.
The platform is not provided. Defaults to the current OS: Linux.
Starting tools applicability analysis...
Tools Applicability Infomation:
Found no applicable tools.Completed tools applicability analysis.
##[error]RunCommandNoOptionsException: No applicable tools were detected. Run requires at least one configuration to run. Provide at least one Guardian config or tool with --config or --tool.
##[error]MSDO CLI exited with an error exit code: 2
oh, wait! if I do this, it works!
- task: MicrosoftSecurityDevOps@1
displayName: Microsoft Security DevOps
env:
Terrascan_IacDir: '$(build.artifactstagingdirectory)/$(ENV)'
inputs:
command: 'run'
break: true
categories: 'IaC,secrets,code'
tools: 'terrascan'
but still not sure if I should use categories, tools or both.
Do you see my concerns?
I hope you can address the documentation gap ASAP.
Many thanks and best regards,
- 主要言語
- TypeScript
- スター
- 86
- フォーク
- 22
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/security-devops-azdevops のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
-
area:task area:tools status:waiting-on-author type:docs type:question
microsoft/security-devops-azdevops#169 · コメント 1 件 · 担当者 1 名 ·
-
Which Defender CLI binary should be used in CI/CD pipelines — `aka.ms` or the DevOps CDN endpoint? オープン
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
microsoft/security-devops-azdevops#166 · コメント 2 件 · リアクション 1 件 ·
-
area:task area:tools status:team-review type:feature
microsoft/security-devops-azdevops#164 · リアクション 2 件 · 担当者 2 名 ·
-
area:task area:tools status:team-review type:docs type:feature
microsoft/security-devops-azdevops#163 · コメント 17 件 · 担当者 1 名 ·
microsoft/security-devops-azdevops の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
area:tools bug good first issue help wanted priority:P2
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
TaewoooPark/Motifcode#14 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
newrelic-experimental/preflight#793 · コメント 1 件 ·
-
bug 🐞
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
[Bounty proposal] fix(web): memory insights count an evening memory on the next day ($25 proposed) オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
BasedHardware/omi#15320 ·