Skip to content

Commit 263a156

Browse files
authored
Updated docs and dependency versions (#267)
* Updated docs and dependency versions * Unified build support/scripting - Now uses a RepoBuild module like other repos in org * Updated build scripts to use new module * Updated .editorconfig to consistent form with other repos in org. * Updated projects to resolve numerous SA issues that were previously suppressed. - These are mostly trivial file header things. * disabled SA1135 for the interop library - It is broken for the using alias in a namespace * Removed ValidatedNotNullAttribute as the existing framework provided `NotNullAttribute` does the same job. * Removed `Build-All.ps1` as the name is confusing and not really helpful anymore. Docs and sources are built distinct in automated builds AND local builds so there's no real value in a wrapper. * Docs build now includes the version of the build it is based on. - This depends on the fact that automated builds will use the timestamp of the HEAD commit for the repo. Local builds use an environment variable. Thus the timestamp/CI Build index remain the same. * Fixed multiple SyleCop Analyzer errors * SA1633, SA1507, SA1633, SA1513, SA1623
1 parent 76ba2be commit 263a156

File tree

93 files changed

+1488
-602
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+1488
-602
lines changed

.editorconfig

Lines changed: 93 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ vsspell_ignored_words_1c7003ec377c4bd9bb3c509d29770210 = File:.\IgnoredWords.dic
1818

1919
# match VS generated formatting for MSBuild project files
2020
[*.*proj,*.props,*.targets]
21+
indent_style = space
22+
indent_size = 2
23+
tab_width = 2
24+
25+
[*.yml,*.yaml]
26+
indent_style = space
2127
indent_size = 2
2228
tab_width = 2
2329

@@ -29,7 +35,7 @@ insert_final_newline = true
2935
csharp_style_conditional_delegate_call = true:warning
3036
csharp_style_expression_bodied_accessors = true:suggestion
3137
csharp_style_expression_bodied_indexers = true:suggestion
32-
csharp_style_expression_bodied_methods = true:suggestion
38+
csharp_style_expression_bodied_methods = false:silent
3339
csharp_style_expression_bodied_operators = when_on_single_line:silent
3440
csharp_style_expression_bodied_properties = true:warning
3541
csharp_style_inlined_variable_declaration = true:warning
@@ -79,19 +85,20 @@ csharp_style_expression_bodied_constructors = false:error
7985
csharp_style_expression_bodied_lambdas = true:warning
8086
csharp_style_expression_bodied_local_functions = true:suggestion
8187
dotnet_diagnostic.RECS0001.severity = error
82-
dotnet_diagnostic.SA1023.severity = none
83-
dotnet_diagnostic.SA1124.severity = none
8488
csharp_style_allow_embedded_statements_on_same_line_experimental = false:error
85-
dotnet_diagnostic.SA1512.severity = none
86-
dotnet_diagnostic.SA1129.severity = error
8789
csharp_style_prefer_null_check_over_type_check = true:error
8890
csharp_prefer_simple_default_expression = true:error
8991
csharp_space_between_method_declaration_parameter_list_parentheses = true
9092
csharp_space_between_method_declaration_empty_parameter_list_parentheses = true
9193
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
9294
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent
93-
dotnet_diagnostic.SA0001.severity = none
94-
dotnet_diagnostic.SA1135.severity = none
95+
dotnet_diagnostic.SA1005.severity = none
96+
97+
# see: https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3920
98+
dotnet_diagnostic.SA1202.severity = none
99+
csharp_style_prefer_local_over_anonymous_function = true:error
100+
csharp_style_prefer_index_operator = true:error
101+
csharp_style_prefer_range_operator = true:error
95102

96103
# Analysis and refactoring rules for Ubiquity.NET
97104
# Description: Code analysis rules for Ubiquity.NET projects
@@ -101,6 +108,72 @@ dotnet_diagnostic.SA1135.severity = none
101108
# Code files
102109
[*.{cs,vb}]
103110

111+
#### Naming styles ####
112+
113+
# Naming rules
114+
115+
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
116+
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
117+
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
118+
119+
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
120+
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
121+
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
122+
123+
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
124+
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
125+
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
126+
127+
# Symbol specifications
128+
129+
dotnet_naming_symbols.interface.applicable_kinds = interface
130+
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
131+
dotnet_naming_symbols.interface.required_modifiers =
132+
133+
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
134+
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
135+
dotnet_naming_symbols.types.required_modifiers =
136+
137+
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
138+
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
139+
dotnet_naming_symbols.non_field_members.required_modifiers =
140+
141+
# Naming styles
142+
143+
dotnet_naming_style.begins_with_i.required_prefix = I
144+
dotnet_naming_style.begins_with_i.required_suffix =
145+
dotnet_naming_style.begins_with_i.word_separator =
146+
dotnet_naming_style.begins_with_i.capitalization = pascal_case
147+
148+
dotnet_naming_style.pascal_case.required_prefix =
149+
dotnet_naming_style.pascal_case.required_suffix =
150+
dotnet_naming_style.pascal_case.word_separator =
151+
dotnet_naming_style.pascal_case.capitalization = pascal_case
152+
153+
dotnet_naming_style.pascal_case.required_prefix =
154+
dotnet_naming_style.pascal_case.required_suffix =
155+
dotnet_naming_style.pascal_case.word_separator =
156+
dotnet_naming_style.pascal_case.capitalization = pascal_case
157+
dotnet_style_coalesce_expression = true:warning
158+
dotnet_style_null_propagation = true:warning
159+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:error
160+
dotnet_style_prefer_auto_properties = true:error
161+
dotnet_style_object_initializer = true:suggestion
162+
dotnet_style_collection_initializer = true:warning
163+
dotnet_style_prefer_simplified_boolean_expressions = true:error
164+
dotnet_style_prefer_conditional_expression_over_assignment = true:warning
165+
dotnet_style_prefer_conditional_expression_over_return = true:warning
166+
dotnet_style_explicit_tuple_names = true:warning
167+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
168+
dotnet_style_prefer_inferred_tuple_names = true:suggestion
169+
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
170+
dotnet_style_prefer_compound_assignment = true:error
171+
dotnet_style_prefer_simplified_interpolation = true:suggestion
172+
dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion
173+
dotnet_style_namespace_match_folder = true:suggestion
174+
dotnet_diagnostic.MSTEST0032.severity = none
175+
dotnet_code_quality_unused_parameters = all:suggestion
176+
104177
# IDE0059: Unnecessary assignment of a value
105178
dotnet_diagnostic.IDE0059.severity = none
106179

@@ -1255,6 +1328,8 @@ dotnet_diagnostic.RECS0147.severity = warning
12551328

12561329
dotnet_diagnostic.RECS0154.severity = suggestion
12571330

1331+
dotnet_diagnostic.SA0001.severity = none
1332+
12581333
dotnet_diagnostic.SA1000.severity = none
12591334

12601335
dotnet_diagnostic.SA1001.severity = none
@@ -1275,6 +1350,8 @@ dotnet_diagnostic.SA1015.severity = none
12751350

12761351
dotnet_diagnostic.SA1021.severity = none
12771352

1353+
dotnet_diagnostic.SA1023.severity = none
1354+
12781355
dotnet_diagnostic.SA1024.severity = error
12791356

12801357
dotnet_diagnostic.SA1025.severity = error
@@ -1311,12 +1388,16 @@ dotnet_diagnostic.SA1121.severity = none
13111388

13121389
dotnet_diagnostic.SA1123.severity = error
13131390

1391+
dotnet_diagnostic.SA1124.severity = none
1392+
13141393
dotnet_diagnostic.SA1125.severity = suggestion
13151394

13161395
dotnet_diagnostic.SA1127.severity = error
13171396

13181397
dotnet_diagnostic.SA1128.severity = error
13191398

1399+
dotnet_diagnostic.SA1129.severity = error
1400+
13201401
dotnet_diagnostic.SA1130.severity = error
13211402

13221403
dotnet_diagnostic.SA1131.severity = error
@@ -1333,8 +1414,6 @@ dotnet_diagnostic.SA1200.severity = error
13331414

13341415
dotnet_diagnostic.SA1201.severity = error
13351416

1336-
dotnet_diagnostic.SA1202.severity = error
1337-
13381417
dotnet_diagnostic.SA1203.severity = none
13391418

13401419
dotnet_diagnostic.SA1204.severity = silent
@@ -1435,6 +1514,8 @@ dotnet_diagnostic.SA1510.severity = error
14351514

14361515
dotnet_diagnostic.SA1511.severity = error
14371516

1517+
dotnet_diagnostic.SA1512.severity = none
1518+
14381519
dotnet_diagnostic.SA1513.severity = error
14391520

14401521
dotnet_diagnostic.SA1514.severity = error
@@ -1503,11 +1584,11 @@ dotnet_diagnostic.SA1634.severity = error
15031584

15041585
dotnet_diagnostic.SA1635.severity = error
15051586

1506-
dotnet_diagnostic.SA1636.severity = error
1587+
dotnet_diagnostic.SA1636.severity = warning
15071588

1508-
dotnet_diagnostic.SA1637.severity = silent
1589+
dotnet_diagnostic.SA1637.severity = warning
15091590

1510-
dotnet_diagnostic.SA1638.severity = silent
1591+
dotnet_diagnostic.SA1638.severity = error
15111592

15121593
dotnet_diagnostic.SA1640.severity = error
15131594

@@ -1527,72 +1608,3 @@ dotnet_diagnostic.SA1652.severity = warning
15271608

15281609
dotnet_diagnostic.SX1101.severity = error
15291610

1530-
# CA2007: Consider calling ConfigureAwait on the awaited task
1531-
dotnet_diagnostic.CA2007.severity = none
1532-
1533-
[*.{cs,vb}]
1534-
#### Naming styles ####
1535-
1536-
# Naming rules
1537-
1538-
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
1539-
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
1540-
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
1541-
1542-
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
1543-
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
1544-
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
1545-
1546-
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
1547-
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
1548-
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
1549-
1550-
# Symbol specifications
1551-
1552-
dotnet_naming_symbols.interface.applicable_kinds = interface
1553-
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
1554-
dotnet_naming_symbols.interface.required_modifiers =
1555-
1556-
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
1557-
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
1558-
dotnet_naming_symbols.types.required_modifiers =
1559-
1560-
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
1561-
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
1562-
dotnet_naming_symbols.non_field_members.required_modifiers =
1563-
1564-
# Naming styles
1565-
1566-
dotnet_naming_style.begins_with_i.required_prefix = I
1567-
dotnet_naming_style.begins_with_i.required_suffix =
1568-
dotnet_naming_style.begins_with_i.word_separator =
1569-
dotnet_naming_style.begins_with_i.capitalization = pascal_case
1570-
1571-
dotnet_naming_style.pascal_case.required_prefix =
1572-
dotnet_naming_style.pascal_case.required_suffix =
1573-
dotnet_naming_style.pascal_case.word_separator =
1574-
dotnet_naming_style.pascal_case.capitalization = pascal_case
1575-
1576-
dotnet_naming_style.pascal_case.required_prefix =
1577-
dotnet_naming_style.pascal_case.required_suffix =
1578-
dotnet_naming_style.pascal_case.word_separator =
1579-
dotnet_naming_style.pascal_case.capitalization = pascal_case
1580-
dotnet_style_coalesce_expression = true:warning
1581-
dotnet_style_null_propagation = true:warning
1582-
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:error
1583-
dotnet_style_prefer_auto_properties = true:error
1584-
dotnet_style_object_initializer = true:suggestion
1585-
dotnet_style_collection_initializer = true:warning
1586-
dotnet_style_prefer_simplified_boolean_expressions = true:error
1587-
dotnet_style_prefer_conditional_expression_over_assignment = true:warning
1588-
dotnet_style_prefer_conditional_expression_over_return = true:warning
1589-
dotnet_style_explicit_tuple_names = true:warning
1590-
dotnet_style_operator_placement_when_wrapping = beginning_of_line
1591-
dotnet_style_prefer_inferred_tuple_names = true:suggestion
1592-
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
1593-
dotnet_style_prefer_compound_assignment = true:error
1594-
dotnet_style_prefer_simplified_interpolation = true:suggestion
1595-
dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion
1596-
dotnet_style_namespace_match_folder = true:suggestion
1597-
dotnet_diagnostic.MSTEST0032.severity = none
1598-
dotnet_code_quality_unused_parameters = all:suggestion

.github/workflows/pr-build.yml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ jobs:
5050
fetch-depth: 0
5151

5252
- name: Build Source
53-
run: ./Build-All.ps1 -ForceClean -BuildMode Source
53+
run: ./Build-Source.ps1 -ForceClean
5454

5555
- name: Run Tests
56-
run: ./Invoke-UnitTests.ps1
56+
run: ./Invoke-Tests.ps1
5757

5858
# Upload test results even if failed; unless cancelled
5959
- name: Upload Test Results
@@ -88,9 +88,3 @@ jobs:
8888
BuildOutput/docs/
8989
!BuildOutput/docs/.git/**
9090
91-
- name: Publish build logs
92-
if: always() && github.event_name == 'pull_request'
93-
uses: actions/upload-artifact@v4
94-
with:
95-
name: Build Logs
96-
path: ./BuildOutput/BinLogs

.github/workflows/release-build.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ jobs:
3131
fetch-depth: 0
3232

3333
- name: Build Source
34-
run: .\Build-All.ps1 -FullInit -BuildMode Source
34+
run: .\Build-Source.ps1 -FullInit -ForceClean
3535

3636
- name: Run Tests
37-
run: ./Invoke-UnitTests.ps1
37+
run: ./Invoke-Tests.ps1
3838

3939
- name: Publish Test Results
4040
uses: actions/upload-artifact@v4
@@ -58,7 +58,7 @@ jobs:
5858
env:
5959
docspush_email: 32618965+cibuild-telliam@users.noreply.github.com
6060
docspush_username: cibuild-telliam
61-
run: .\Push-Docs.ps1 -SkipPush
61+
run: .\Commit-Docs.ps1
6262

6363
- name: Publish Docs
6464
uses: ad-m/github-push-action@master

0 commit comments

Comments
 (0)