Doc-Warden is an internal project created by the Azure SDK Team. It is intended to be used by CI Builds to ensure that documentation standards are met. See readme for more details.
Project description
Doc Warden
Every CI build owned by the Azure-SDK team also needs to verify that the documentation within the target repo meets a set of standards. Doc-warden
is intended to ease the implementation of these checks in CI builds.
Features:
- Enforces Readme Standards
- Readmes present - completed
- Readmes have appropriate contents - completed
- Generates report for included observed packages - pending
This package is tested on Python 2.7 -> 3.8.
Prerequisites
This package is intended to be run as part of a pipeline within Azure DevOps. As such, Python must be installed prior to attempting to install or use Doc-Warden.
While pip
comes pre-installed on most modern Python installs, if pip
is an unrecognized command when attempting to install warden
, run the following command after your Python installation is complete.
In addition, warden
is distributed using setuptools
and wheel
, so those packages should also be present prior to install.
/:> python -m ensurepip
/:> pip install setuptools wheel
Usage
Right now, warden
has a single command. scan
, which by default looks for a target .docsettings.yml
file within the target repo. However, all the parameters that can be pulled from the .docsettings
files will override whatever is placed within the .docsettings
file.
Example usage:
<pre-step, clone target repository>
...
/:> pip install setuptools wheel
/:> pip install doc-warden
...
<next task, because PATH doesn't update without another one>
/:> ward scan -d $(Build.SourcesDirectory)
Notes for example above
- Assumption is that the
.docsettings
file is placed at the root of the repository.
To provide a different path (like azure-sdk-for-java
does...), use:
/:> ward scan -d $(Build.SourcesDirectory) -c $(Build.SourcesDirectory)/eng/.docsettings.yml
Parameter Options
command
Currently supports 3 commands. Values: ['scan', 'presence', 'content']
Required.
scan
checks both readme presence as well as readme contentcontent
checks just the content- and as you'd expect,
presence
just checks for readmes existing where they should be.
--scan-directory
The target directory warden
should be scanning. Required.
--scan-language
warden
checks for packages by convention, so it needs to understand what language it is looking at. This must be populated either in .docsettings file
or by parameter. Required.
--config-location
By default, warden
looks for the .docsettings
file in the root of the repository. However, populating this location will override this behavior and instead pull the file from the location in this parameter. Optional.
--verbose-output
Enable or disable output of an html report. Defaults to false. Optional.
Notes for Devops Usage
The -d
argument should be $(Build.SourcesDirectory)
. This will point warden
at the repo that has been associated with CI.
Methodology
Enforcing Readme Presence
When should we expect a readme to be present?
Always:
- At the root of the repo
- Associated with a
package
directory
.Net
A package directory is indicated by:
- a
*.sln
file under thesdk
directory
Python
A package directory is indicated by:
- the presence of a
setup.py
file
Java
A package directory is indicated by:
- the presence of a
pom.xml
file- The POM
<packaging>
value within is set toJAR
- The POM
Node & JS
A package directory is indicated by:
- The presence of a
package.json
file
Enforcing Readme Content
doc-warden
has the ability to check discovered readme files to ensure that a set of configured sections is present. How does it work? doc-warden
will ensure that each regex defined in required_readme_sections
matches against at least one section header in the readme. If all the patterns match at least one header, the readme will pass content verification.
Other Notes:
- A
section
header is any markdown or RST that will result in a<h1>
to<h2>
html tag. warden
will content verify anyreadme.rst
orreadme.md
file found outside theomitted_paths
in the targeted repo.
Control, the .docsettings.yml
File, and You
Special cases often need to be configured. It seems logical that there needs be a central location (per repo) to override conventional settings. To that end, a new .docsettings.yml
file will be added to each repo.
<repo-root>
│ README.md
│ .docsettings.yml
│
└───.azure-pipelines
│ │ <build def>
│
└───<other files and folders>
The presence of this file allows each repository to customize how enforcement takes place within their repo.
Example DocSettings File for Java Repo
omitted_paths:
- archive/*
language: java
root_check_enabled: True
required_readme_sections:
- "(Client Library for Azure .*|Microsoft Azure SDK for .*)"
- Getting Started
known_presence_issues:
- ['cognitiveservices/data-plane/language/bingspellcheck', '#2847']
known_content_issues:
- ['sdk/template/azure-sdk-template/README.md','#1368']
The above configuration tells warden
...
- The language within the repo is
java
- To ensure that a
README.md
is present at the root of the repository. - To omit any paths under
archive/
from the readme checks.
Possible values for language
right now are ['net', 'java', 'js', 'python']
. Greater than one target language is not currently supported.
required_readme_sections
Configuration
This section instructs warden
to verify that there is at least one matching section title for each provided section
pattern in any discovered readme. Regex is fully supported.
The two items listed from the example .docsettings
file will:
- Match a header matched by a simple regex expression
- Match a header exactly titled "Getting Started"
Note that the regex is surrounded by quotation marks where the regex will break yml
parsing of the configuration file.
known_presence_issues
and known_content_issues
Configuration
doc-warden
is designed to crash builds if it detects failures. However, the vast majority of the time, these issues cannot be fixed immediately. In the above configuration, there are two paths highlighted as known issues.
The first, known_presence_issues
, tells warden that a presence failure detected at the specified paths should be ignored and should not result in a crashed build. A tuple
describing each known issue specifies both what the known issue is, as well as some sort of justification. Having an exception with an issueId attached is a good justification for not failing the build.
We're aware of this issue, and it is tracked in the following github issue.
The known_content_issues
parameter functions identically to the known_presence_issues
check. If a readme is listed as "already known" to have failures, the entire CI build will not be crashed by Warden.
Provide Feedback
If you encounter any bugs or have suggestions, please file an issue here and assign to scbedd
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for doc_warden-0.2.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e9204cc0c26ac5b764ca6837cf00a912c746beb270662f6d11bea60fc14f171 |
|
MD5 | 4014df70bc95b55b8b4b3ece4e6df98c |
|
BLAKE2b-256 | eebe07ba42d1101acc9b69160766d896421132bb545118fc01879cf7d0b22be9 |