Really poor documentation....?
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của microsoft/security-devops-azdevops
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 68/100
-
area:task area:tools status:waiting-on-author type:docs type:question
microsoft/security-devops-azdevops#169 · 1 bình luận · 1 người được giao ·
-
Which Defender CLI binary should be used in CI/CD pipelines — `aka.ms` or the DevOps CDN endpoint? Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
microsoft/security-devops-azdevops#166 · 2 bình luận · 1 reaction ·
-
area:task area:tools status:team-review type:feature
microsoft/security-devops-azdevops#164 · 2 reaction · 2 người được giao ·
-
area:task area:tools status:team-review type:docs type:feature
microsoft/security-devops-azdevops#163 · 17 bình luận · 1 người được giao ·
Tất cả issue của microsoft/security-devops-azdevops
Issue tương tự
-
comp/desktop P3 type/bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
NousResearch/hermes-agent#118866 ·
-
Browser Waiting for: Product Owner
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
getsentry/sentry-javascript#24577 · 1 bình luận ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
agilepathway/label-checker#640 ·
-
Plugin stuck at "loading" on DSH 0.1.6-alpha.2 — turnTail list slot registration missing options.id Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
-
Add 2021 Cup data to website Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
chrisparsons83/flexspotff#153 ·