Skip to content

Commit

Permalink
Refactor OSS-FindSquats to publish as Lib (#277)
Browse files Browse the repository at this point in the history
* Rewrite Nuget publishing pipeline
* Refactor + rewrite FindSquats logic into a library
* Publish FindSquatsLib nuget
* Publish Shared nuget

Co-authored-by: Julian <julian.pinzer@gmail.com>
  • Loading branch information
gfs and jpinz authored Nov 19, 2021
1 parent dd3d244 commit 270a7a2
Show file tree
Hide file tree
Showing 78 changed files with 2,946 additions and 1,576 deletions.
46 changes: 46 additions & 0 deletions Pipelines/core-pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -281,3 +281,49 @@ stages:
$(Build.StagingDirectory)/HASHES.txt
changeLogCompareToRelease: 'lastNonDraftRelease'
changeLogType: 'commitBased'

- stage: Publish_Shared_Nuget
dependsOn:
- SDL
condition: and(succeeded(), in(variables['Build.Reason'], 'IndividualCI', 'BatchedCI'))
jobs:
- template: templates/check-changes.yml
parameters:
jobName: 'check_changes_Shared'
tagName: 'code_changed'
pathArgument: 'Pipelines/nuget-build-job.yml,Pipelines/check-changes.yml,src/Shared'
- template: templates/nuget-build-job.yml
parameters:
jobName: 'pack_shared'
projectPath: 'src/Shared/Shared.csproj'
projectName: 'Shared'
dependsOnArg: 'check_changes_Shared'
conditionedOnTag: 'code_changed'
publishToNuget: true

- stage: Publish_OSS_Find_Squats_Nuget
dependsOn:
- SDL
condition: and(succeeded(), in(variables['Build.Reason'], 'IndividualCI', 'BatchedCI'))
jobs:
- template: templates/check-changes.yml
parameters:
jobName: 'check_changes_oss_find_squats'
tagName: 'code_changed'
pathArgument: 'Pipelines/nuget-build-job.yml,Pipelines/check-changes.yml,src/oss-find-squats,src/oss-find-squats-lib,src/Shared'
- template: templates/nuget-build-job.yml
parameters:
jobName: 'pack_oss_find_squats'
projectPath: 'src/oss-find-squats/oss-find-squats.csproj'
projectName: 'oss-find-squats'
dependsOnArg: 'check_changes_oss_find_squats'
conditionedOnTag: 'code_changed'
publishToNuget: true
- template: templates/nuget-build-job.yml
parameters:
jobName: 'pack_oss_find_squats_lib'
projectPath: 'src/oss-find-squats-lib/oss-find-squats-lib.csproj'
projectName: 'oss-find-squats-lib'
dependsOnArg: 'check_changes_oss_find_squats'
conditionedOnTag: 'code_changed'
publishToNuget: true
18 changes: 0 additions & 18 deletions Pipelines/nuget-pipelines/oss-find-squats.yml

This file was deleted.

44 changes: 44 additions & 0 deletions Pipelines/templates/check-changes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
parameters:
# Job Name
- name: jobName
type: string
default: 'check_changes'
# tag name
- name: tagName
type: string
default: 'code_changed'
# Comma Separated paths Name
- name: pathArgument
type: string
default: '/'

jobs:
- job: ${{ parameters.jobName }}
displayName: Checking for changed paths
steps:
- bash: |
CHANGED_FILES=$(git diff HEAD HEAD~ --name-only)
echo "Checking for file changes..."
readarray -d , -t strarr <<<"${{ parameters.pathArgument }}"
for (( n=0; n < ${#strarr[*]} && !DONE; n++ ))
do
for FILE in $CHANGED_FILES
do
if [[ $FILE == *${strarr[n]}* ]]; then
echo "MATCH: ${FILE} changed"
echo "##vso[task.setvariable variable=${{ parameters.tagName }};isOutput=true]true"
DONE=true
break
fi
done
done
if [ -z ${DONE} ]; then
echo "No matching paths found."
echo "##vso[task.setvariable variable=${{ parameters.tagName }};isOutput=true]false"
fi
echo $${{parameters.tagName}}
name: check_script
19 changes: 17 additions & 2 deletions Pipelines/templates/nuget-build-job.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,28 @@ parameters:
- name: artifactName
type: string
default: 'Unsigned_Binaries'
# Should the resulting built nugets be signed and published to Nuget.org
- name: publishToNuget
type: boolean
default: false
# The Job name for the pipeline that checked paths
- name: dependsOnArg
type: string
default: []
# The tag set by the checking job
- name: conditionedOnTag
type: string
default: 'code_changed'
# Should the resulting nugets be marked as a public release (disable prerelease versioning)
- name: publicRelease
type: boolean
default: true

jobs:
- job: ${{ parameters.jobName }}
displayName: NuGet Package
dependsOn: ${{ parameters.dependsOnArg }}
condition: eq(dependencies.${{ parameters.dependsOnArg }}.outputs['check_script.${{ parameters.conditionedOnTag }}'], 'true')
displayName: NuGet Package ${{ parameters.projectName }}
pool:
vmImage: 'windows-latest'
steps:
Expand All @@ -63,7 +78,7 @@ jobs:
inputs:
command: 'custom'
custom: 'pack'
arguments: '${{ parameters.projectPath }} -c ${{ parameters.buildConfiguration }} -o Packages'
arguments: '${{ parameters.projectPath }} -c ${{ parameters.buildConfiguration }} -o Packages /p:PublicRelease=${{ parameters.publicRelease }}'
- task: AntiMalware@3
displayName: Anti-Malware Scan
inputs:
Expand Down
220 changes: 215 additions & 5 deletions src/.editorconfig
Original file line number Diff line number Diff line change
@@ -1,7 +1,217 @@
[*.cs]
# Remove the line below if you want to inherit .editorconfig settings from higher directories
root = true

# CS1998: Async method lacks 'await' operators and will run synchronously
dotnet_diagnostic.CS1998.severity = silent
# C# files
[*.cs]

# CS1031: Do not catch general exception types
dotnet_diagnostic.CA1031.severity = silent
#### Core EditorConfig Options ####

# Indentation and spacing
indent_size = 4
indent_style = space
tab_width = 4

# New line preferences
end_of_line = crlf
insert_final_newline = false

#### .NET Coding Conventions ####

# Organize usings
dotnet_separate_import_directive_groups = false
dotnet_sort_system_directives_first = false
file_header_template = Copyright (c) Microsoft Corporation. Licensed under the MIT License.

# this. and Me. preferences
dotnet_style_qualification_for_event = false:warning
dotnet_style_qualification_for_field = false
dotnet_style_qualification_for_method = false:warning
dotnet_style_qualification_for_property = false:warning

# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true:warning
dotnet_style_predefined_type_for_member_access = true:warning

# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity
dotnet_style_parentheses_in_other_operators = never_if_unnecessary
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity

# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members

# Expression-level preferences
dotnet_style_coalesce_expression = true
dotnet_style_collection_initializer = true
dotnet_style_explicit_tuple_names = true
dotnet_style_namespace_match_folder = true
dotnet_style_null_propagation = true
dotnet_style_object_initializer = true
dotnet_style_operator_placement_when_wrapping = beginning_of_line
dotnet_style_prefer_auto_properties = true:warning
dotnet_style_prefer_compound_assignment = true
dotnet_style_prefer_conditional_expression_over_assignment = true
dotnet_style_prefer_conditional_expression_over_return = true
dotnet_style_prefer_inferred_anonymous_type_member_names = true
dotnet_style_prefer_inferred_tuple_names = true
dotnet_style_prefer_is_null_check_over_reference_equality_method = true
dotnet_style_prefer_simplified_boolean_expressions = true
dotnet_style_prefer_simplified_interpolation = true

# Field preferences
dotnet_style_readonly_field = true

# Parameter preferences
dotnet_code_quality_unused_parameters = all

# Suppression preferences
dotnet_remove_unnecessary_suppression_exclusions = none

# New line preferences
dotnet_style_allow_multiple_blank_lines_experimental = false
dotnet_style_allow_statement_immediately_after_block_experimental = false

#### C# Coding Conventions ####

# var preferences
csharp_style_var_elsewhere = false:warning
csharp_style_var_for_built_in_types = false:warning
csharp_style_var_when_type_is_apparent = false:warning

# Expression-bodied members
csharp_style_expression_bodied_accessors = true
csharp_style_expression_bodied_constructors = false
csharp_style_expression_bodied_indexers = true
csharp_style_expression_bodied_lambdas = true
csharp_style_expression_bodied_local_functions = false
csharp_style_expression_bodied_methods = when_on_single_line
csharp_style_expression_bodied_operators = when_on_single_line
csharp_style_expression_bodied_properties = true

# Pattern matching preferences
csharp_style_pattern_matching_over_as_with_null_check = true
csharp_style_pattern_matching_over_is_with_cast_check = true
csharp_style_prefer_not_pattern = true
csharp_style_prefer_pattern_matching = true:suggestion
csharp_style_prefer_switch_expression = true

# Null-checking preferences
csharp_style_conditional_delegate_call = true

# Modifier preferences
csharp_prefer_static_local_function = true
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async

# Code-block preferences
csharp_prefer_braces = when_multiline:warning
csharp_prefer_simple_using_statement = true:warning

# Expression-level preferences
csharp_prefer_simple_default_expression = true
csharp_style_deconstructed_variable_declaration = true
csharp_style_implicit_object_creation_when_type_is_apparent = true
csharp_style_inlined_variable_declaration = true
csharp_style_pattern_local_over_anonymous_function = true
csharp_style_prefer_index_operator = true
csharp_style_prefer_range_operator = true
csharp_style_throw_expression = true
csharp_style_unused_value_assignment_preference = discard_variable
csharp_style_unused_value_expression_statement_preference = discard_variable

# 'using' directive preferences
csharp_using_directive_placement = inside_namespace:suggestion

# New line preferences
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = false
csharp_style_allow_embedded_statements_on_same_line_experimental = true

#### C# Formatting Rules ####

# New line preferences
csharp_new_line_before_catch = true
csharp_new_line_before_else = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_open_brace = all
csharp_new_line_between_query_expression_clauses = true

# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = true
csharp_indent_labels = one_less_than_current
csharp_indent_switch_labels = true

# Space preferences
csharp_space_after_cast = false
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_semicolon_in_for_statement = true
csharp_space_around_binary_operators = before_and_after
csharp_space_around_declaration_statements = false
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_open_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false

# Wrapping preferences
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = true

#### Naming styles ####

# Naming rules

dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i

dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case

dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case

# Symbol specifications

dotnet_naming_symbols.interface.applicable_kinds = interface
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.interface.required_modifiers =

dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.types.required_modifiers =

dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.non_field_members.required_modifiers =

# Naming styles

dotnet_naming_style.pascal_case.required_prefix =
dotnet_naming_style.pascal_case.required_suffix =
dotnet_naming_style.pascal_case.word_separator =
dotnet_naming_style.pascal_case.capitalization = pascal_case

dotnet_naming_style.begins_with_i.required_prefix = I
dotnet_naming_style.begins_with_i.required_suffix =
dotnet_naming_style.begins_with_i.word_separator =
dotnet_naming_style.begins_with_i.capitalization = pascal_case
8 changes: 7 additions & 1 deletion src/OSSGadget.sln
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "oss-diff", "oss-diff\oss-di
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "oss-find-domain-squats", "oss-find-domain-squats\oss-find-domain-squats.csproj", "{E8884AC4-638F-4513-A5BD-4650E19CE071}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "oss-reproducible", "oss-reproducible\oss-reproducible.csproj", "{B79FCA22-5A3B-47F5-8FB1-692E3175162D}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "oss-reproducible", "oss-reproducible\oss-reproducible.csproj", "{B79FCA22-5A3B-47F5-8FB1-692E3175162D}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "oss-find-squats-lib", "oss-find-squats-lib\oss-find-squats-lib.csproj", "{182CA72B-6BB1-400E-83FC-B35558928BAB}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down Expand Up @@ -103,6 +105,10 @@ Global
{B79FCA22-5A3B-47F5-8FB1-692E3175162D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B79FCA22-5A3B-47F5-8FB1-692E3175162D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B79FCA22-5A3B-47F5-8FB1-692E3175162D}.Release|Any CPU.Build.0 = Release|Any CPU
{182CA72B-6BB1-400E-83FC-B35558928BAB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{182CA72B-6BB1-400E-83FC-B35558928BAB}.Debug|Any CPU.Build.0 = Debug|Any CPU
{182CA72B-6BB1-400E-83FC-B35558928BAB}.Release|Any CPU.ActiveCfg = Release|Any CPU
{182CA72B-6BB1-400E-83FC-B35558928BAB}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
Loading

0 comments on commit 270a7a2

Please sign in to comment.