Skip to content

Commit

Permalink
enabling readme verification in .NET repo
Browse files Browse the repository at this point in the history
  • Loading branch information
scbedd committed Mar 15, 2019
1 parent 0e53196 commit e12dbf2
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .azure-pipelines/client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ jobs:
vmImage: 'vs2017-win2016'

steps:
- task: UsePythonVersion@0
displayName: 'Use Python 3.6'
inputs:
versionSpec: '3.6'

- script: |
pip install setuptools wheel
pip install doc-warden
ward scan -d $(Build.SourcesDirectory) -c $(Build.SourcesDirectory)/eng/.docsettings.yml
displayName: 'Verify Readmes'
- task: DownloadBuildArtifacts@0
displayName: 'Download Build Artifacts'
condition: and(succeededOrFailed(), ne(variables['Build.Reason'],'PullRequest'))
Expand Down
19 changes: 19 additions & 0 deletions eng/.docsettings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
omitted_paths:
- archive/*
- eng/*
- tools/*
- src/*
- Documentation/*
language: net
root_check_enabled: True
required_readme_sections:
- "Azure .+ client library for .NET"
- ^Getting started$
- ^Key concepts$
- ^Examples$
- ^Troubleshooting$
- ^Next steps$
- ^Contributing$
known_presence_issues:
known_content_issues:
- ['README.md','Root readme']
4 changes: 4 additions & 0 deletions sdk/template/Azure.Template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ If the package or a related package supports it, include tips for logging or ena
* If appropriate, point users to other packages that might be useful.
* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for.

## Contributing

This is a template, but your SDK readme should include details on how to contribute code to the repo/package.

<!-- LINKS -->
[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization
[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357
Expand Down

0 comments on commit e12dbf2

Please sign in to comment.