Really poor documentation....?

オープン
#94 コメント 3 件 リアクション 7 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
28/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
azure, typescript

調査の方向性

まず、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 はありません

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

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

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/security-devops-azdevops のほかの issue

microsoft/security-devops-azdevops の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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