merge: branch 'master' into release

.github/FUNDING.yml

@@ -0,0 +1,9 @@
+ko_fi: victorvogelpoel
+custom:
+    # PayPal donation button is superior to a paypal.me link because it
+    # additionally:
+    #   - accepts credit cards without a need to create a PayPal account
+    #   - allows monthly subscriptions (requires a PayPal account)
+    # However, the URL is rather lengthy and GitHub shows it in full in the
+    # Sponsor modal popup.
+    https://www.paypal.com/donate?business=XNDBFRKBLTKJ2&no_recurring=0&item_name=Help+me+improve+mfile+serilog+sinks&currency_code=EUR

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+<!--
+
+Have you read Serilog.Sinks.MFilesObject Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/victorvogelpoel/Serilog.Sinks.MFilesObject/.github/blob/master/CODE_OF_CONDUCT.md
+
+-->
+
+### Prerequisites
+
+
+### Description
+
+<!-- Description of the issue -->
+
+### Steps to Reproduce
+
+1. <!-- First Step -->
+2. <!-- Second Step -->
+3. <!-- and so on… -->
+
+**Expected behavior:**
+
+<!-- What you expect to happen -->
+
+**Actual behavior:**
+
+<!-- What actually happens -->
+
+**Reproduces how often:**
+
+<!-- What percentage of the time does it reproduce? -->
+
+### Versions
+
+
+### Additional Information
+
+<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. -->

.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  - package-ecosystem: "nuget"
+    directory: "/src"
+    schedule:
+      interval: "daily"
+    target-branch: "master"
+    ignore:
+      - dependency-name: "Serilog"
+  - package-ecosystem: "nuget"
+    directory: "/test"
+    schedule:
+      interval: "daily"
+    target-branch: "master"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "release"

.github/workflows/Build on push.yml

@@ -3,7 +3,7 @@ name: Build Serilog.Sinks.MFilesObject
 on:
   workflow_dispatch:
   push:
-    branches: [ master, main, develop, release/*, feature/* ]
+    branches: [ master, main, develop, release/*, prerelease/*, feature/* ]
     paths: ["src/**"]
 
 jobs:
@@ -20,6 +20,9 @@ jobs:
     - name: Setup NuGet
       uses: NuGet/[email protected]
 
+    - name: Set timezone on Windows to Central Europe Standard Time
+      run: tzutil /s "Central Europe Standard Time"
+
     - name: Restore NuGet packages
       run: nuget restore Serilog.Sinks.MFilesObject.sln
 

.github/workflows/Publish-current-to-nuget.yml

@@ -2,8 +2,8 @@ name: Publish current to nuget
 on:
   workflow_dispatch:
   push:
-    branches: [ release ]
-    paths: ["current/**"]
+    branches: [ release, prerelease ]
+    paths: ["current-release/**"]
 
 jobs:
   publish-nupkg:

.gitignore

@@ -445,7 +445,8 @@ $RECYCLE.BIN/
 *.msi
 
 TEMP/
-src.RESEARCH/COMAPI.Extensions.Community/
 src.RESEARCH/serilog/
+src.RESEARCH/COMAPI.Extensions.Community/
 src.RESEARCH/serilog-sinks-console/
 src.RESEARCH/VAF.Extensions.Community/
+*.publickey

CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+`Serilog.Sinks.MFilesObject` is a Serilog structured logging sink that uses the M-Files COM API to emit event messages to a "rolling" Log object or Log file in an M-Files vault.
+
+*"M-Files is the intelligent document management system. With M-Files, organizations organize all their documents and information so that they can easily find, manage and secure them. M-Files is the smartest DMS you’ve ever seen."*
+
+Use Serilog structured logging in your M-Files console, integration and vault application solutions and see the logging appear as an object in the vault. Just open the M-Files desktop app and inspect the logging of your application.
+
+## v1.0.0
+
+### Features
+
+Use Serilog structured logging in your M-Files console, integration and vault application solutions with M-Files COM API and see the structured logging appear as a Log object or Log file in the vault. 
+
+This release features two sinks:
+
+* `MFilesLogObjectMessageSink`: Log to a M-Files Log object with a multi-line text property.
+* `MFilesLogFileSink`: Log to an M-Files Log File.
+
+Both sinks work with batching, where new log messages are appended every 10 seconds, to prevent overly stress on the vault.
+
+#### Log object
+
+The log object is 'rolling': the sinks creates a new Log object in the vault for the current day, eg "Log 2022-01-27". When the multi-line text property reaches its limit of 10000 characters, the sink creates a new Log object for today with an ordinal between braces, eg "Log 2022-01-27 (2)".
+
+#### Log file
+
+The log file is 'rolling' as well, where the sink creates a Log text file document for the current day, eg "Log 2022-01-27.txt".
+
+### Requirements
+
+These sinks require a M-Files COM API installation, which is installed with the M-Files Desktop app.
+
+
+<!--
+## v1.0.0
+
+### Features
+
+### Improvements
+
+### Fixes
+
+### Other
+
+### Breaking changes
+
+-->

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to Serilog.Sinks.MFilesObject<!-- omit in toc -->
+
+- [Developing Serilog.Sinks.MFilesObject](#developing-serilogsinksmfilesobject)
+- [Reporting a bug](#reporting-a-bug)
+- [Request a feature](#request-a-feature)
+- [Commit message](#commit-message)
+
+
+## Developing Serilog.Sinks.MFilesObject
+
+## Reporting a bug
+
+You can report a bug using the project's [GitHub issue tracker](https://github.com/victorvogelpoel/Serilog.Sinks.MFilesObject/issues). When you are creating a bug report, please include as many details as possible. Fill out the [template](https://github.com/victorvogelpoel/Serilog.Sinks.MFilesObject/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md).
+
+## Request a feature
+
+Use the [GitHub issue tracker](https://github.com/victorvogelpoel/Serilog.Sinks.MFilesObject/issues) to request a new feature.
+
+## Commit message
+
+In the Serilog.Sinks.MFilesObject project, the conventional commit message is used. See the [convention-COMMIT-MESSAGE.md](../../convention-COMMIT-MESSAGE.md) file for more information.

Default.Build.props

@@ -0,0 +1,12 @@
+Project>
+  <PropertyGroup>
+    <CodeAnalysisRuleSet>$(SolutionDir)MyRuleset.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+    <PackageReference
+      Include="SonarAnalyzer.CSharp"
+      Version="8.29.0.36737"
+      PrivateAssets="all"
+      Condition="$(MSBuildProjectExtension) == '.csproj'"
+    />
+  </ItemGroup>
+</Project>

Directory.Build.props

@@ -2,7 +2,25 @@
     <PropertyGroup>
         <Authors>Victor Vogelpoel &amp; contributers</Authors>
         <Company>Dramatic Development</Company>
-        <Copyright>Copyright (c) 2021 Dramatic Development - Victor Vogelpoel</Copyright>
+        <Copyright>Copyright (c) 2022 Dramatic Development - Victor Vogelpoel</Copyright>
         <FileVersion>$([System.DateTime]::Now.ToString("yyyy.MM.dd.HHmm"))</FileVersion>
+
+        <NeutralLanguage>en-US</NeutralLanguage>
+        <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+
     </PropertyGroup>
+
+    <PropertyGroup>
+        <VersionPrefix>1.0.0</VersionPrefix>
+        <VersionSuffix></VersionSuffix>
+        <IncludePreReleaseLabelInPackageVersion Condition="'$(IS_STABLE_BUILD)' != 'true'">true</IncludePreReleaseLabelInPackageVersion>
+        <BuildNumber Condition=" '$(BuildNumber)' == '' ">$(GITHUB_RUN_NUMBER)</BuildNumber>
+        <BuildNumber Condition=" '$(BuildNumber)' == '' ">0</BuildNumber>
+        <VersionSuffix Condition=" '$(VersionSuffix)' != '' ">$(VersionSuffix).$(BuildNumber)</VersionSuffix>
+        <RepositoryCommit Condition="'$(RepositoryCommit)' == ''">$(GITHUB_SHA)</RepositoryCommit>
+        <PackageVersion>$(VersionPrefix)</PackageVersion>
+        <!--PackageVersion Condition=" '$(IncludePreReleaseLabelInPackageVersion)' == 'true' ">$(PackageVersion)-$(VersionSuffix)</PackageVersion-->
+        <InformationalVersion Condition="'$(RepositoryCommit)' != ''">$(PackageVersion)+$(RepositoryCommit)</InformationalVersion>
+    </PropertyGroup>
+
 </Project>