Skip to content

Commit 607d450

Browse files
committed
initial DOCtor-RST setup.
1 parent bcb245e commit 607d450

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

.doctor-rst.yaml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
rules:
2+
no_inheritdoc: ~
3+
avoid_repetetive_words: ~
4+
blank_line_after_directive: ~
5+
short_array_syntax: ~
6+
no_app_console: ~
7+
typo: ~
8+
replacement: ~
9+
composer_dev_option_not_at_the_end: ~
10+
no_composer_req: ~
11+
yarn_dev_option_at_the_end: ~
12+
versionadded_directive_should_have_version: ~
13+
deprecated_directive_should_have_version: ~
14+
no_php_open_tag_in_code_block_php_directive: ~
15+
no_blank_line_after_filepath_in_php_code_block: ~
16+
no_blank_line_after_filepath_in_yaml_code_block: ~
17+
no_blank_line_after_filepath_in_xml_code_block: ~
18+
no_blank_line_after_filepath_in_twig_code_block: ~
19+
php_prefix_before_bin_console: ~
20+
use_deprecated_directive_instead_of_versionadded: ~
21+
no_space_before_self_xml_closing_tag: ~
22+
no_explicit_use_of_code_block_php: ~
23+
ensure_order_of_code_blocks_in_configuration_block: ~
24+
american_english: ~
25+
valid_use_statements: ~
26+
lowercase_as_in_use_statements: ~
27+
ordered_use_statements: ~
28+
no_namespace_after_use_statements: ~
29+
use_https_xsd_urls: ~
30+
correct_code_block_directive_based_on_the_content: ~
31+
max_blank_lines:
32+
max: 2
33+
replace_code_block_types: ~
34+
35+
# 3.4
36+
versionadded_directive_major_version:
37+
major_version: 3
38+
39+
versionadded_directive_min_version:
40+
min_version: '3.0'
41+
42+
# do not report as violation
43+
whitelist:
44+
regex:
45+
- '/FOSUserBundle(.*)\.yml/'
46+
- '/``.yml``/'
47+
- '/(.*)\.orm\.yml/' # currently DoctrineBundle only supports .yml
48+
lines:
49+
- 'in config files, so the old ``app/config/config_dev.yml`` goes to'
50+
- '#. The most important config file is ``app/config/services.yml``, which now is'
51+
- 'code in production without a proxy, it becomes trivially easy to abuse your'
52+
- '.. _`EasyDeployBundle`: https://github.com/EasyCorp/easy-deploy-bundle'
53+
- 'The bin/console Command'
54+
- '# username is your full Gmail or Google Apps email address'
55+
- '.. _`LDAP injection`: http://projects.webappsec.org/w/page/13246947/LDAP%20Injection'
56+
- '.. versionadded:: 0.21.0' # Encore
57+
- '.. versionadded:: 2.4.0' # SwiftMailer
58+
- '.. versionadded:: 1.26' # Twig
59+
- '.. versionadded:: 1.30' # Twig
60+
- '.. versionadded:: 1.2' # MakerBundle
61+
- '.. versionadded:: 1.11' # MakerBundle
62+
- '.. versionadded:: 1.3' # MakerBundle
63+
- '.. versionadded:: 1.8' # MakerBundle

.github/main.workflow

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
workflow "Test" {
2+
on = "push"
3+
resolves = [
4+
"DOCtor-RST",
5+
]
6+
}
7+
8+
action "DOCtor-RST" {
9+
uses = "docker://oskarstark/doctor-rst"
10+
args = "--short"
11+
}

0 commit comments

Comments
 (0)