Really poor documentation....?

Đang mở
#94 3 bình luận 7 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
28/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
azure, typescript
Lĩnh vực
devops, documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem lại wiki và cấu hình tác vụ MicrosoftSecurityDevOps@1 được hiển thị trong issue, bao gồm các biến môi trường, danh mục, công cụ và các đầu vào lệnh. Ghi lại khi nào nên sử dụng danh mục thay vì công cụ, cách cấu hình các biến như Terrascan_IacDir, đồng thời cung cấp một ví dụ hoạt động đã được xác thực, bao quát lỗi được báo cáo và cấu hình thành công.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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,

Ngôn ngữ chính
TypeScript
Star
86
Fork
22
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/security-devops-azdevops

Tất cả issue của microsoft/security-devops-azdevops

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.