Merge branch 'loresoft:master' into master

Author: timmac-qmc

.github/dependabot.yml

@@ -1,5 +1,12 @@
 version: 2
 updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "01:00"   
+  open-pull-requests-limit: 10
+
 - package-ecosystem: nuget
   directory: "/"
   schedule:

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+    tags:
+      - 'v*'
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - name: Install mkdocs
+        run: pip install mkdocs-material
+
+      - name: Build Documentation
+        run: mkdocs build
+
+      - name: Upload Documentation
+        if: success()
+        uses: actions/upload-pages-artifact@v3
+        with:
+          name: github-pages
+          path: 'site/'
+
+  pages:
+    runs-on: ubuntu-latest
+    needs: build
+    if: success()
+
+    permissions:
+      pages: write
+      id-token: write
+
+    steps:
+      - name: Deploy Documentation
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}

.github/workflows/dotnet.yml

@@ -3,6 +3,7 @@ name: Build
 env:
   DOTNET_NOLOGO: true
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  DOTNET_ENVIRONMENT: github
   ASPNETCORE_ENVIRONMENT: github
   BUILD_PATH: '${{github.workspace}}/artifacts'
   COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
@@ -14,6 +15,9 @@ on:
       - develop
     tags:
       - 'v*'
+    paths-ignore:
+      - 'docs/**'
+      - 'mkdocs.yml'
   pull_request:
     branches:
       - master
@@ -37,16 +41,16 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
-    - name: Install .NET Core
-      uses: actions/setup-dotnet@v3
+    - name: Install .NET
+      uses: actions/setup-dotnet@v4
       with:
-          dotnet-version: | 
+          dotnet-version: |
                 6.0.x
-                7.0.x
+                8.0.x
 
     - name: Restore Dependencies
       run: dotnet restore
@@ -55,29 +59,22 @@ jobs:
       run: dotnet build --no-restore --configuration Release
 
     - name: Run Test
-      run: dotnet test --configuration Release --collect:"XPlat Code Coverage" --settings coverlet.runsettings
-
-    - name: Generate Coverage 
-      uses: danielpalme/[email protected]
-      with:
-        reports: '${{github.workspace}}/test/*/TestResults/*/coverage.info'
-        targetdir: ${{env.BUILD_PATH}}
-        reporttypes: lcov
+      run: dotnet test --no-build --configuration Release --collect:"XPlat Code Coverage" --settings coverlet.runsettings
 
     - name: Report Coverage
       if: success()
       uses: coverallsapp/github-action@v2
       with:
-          file: artifacts/lcov.info
-          format: lcov
+        file: "${{github.workspace}}/test/*/TestResults/*/coverage.info"
+        format: lcov
 
     - name: Create Packages
       if: success() && github.event_name != 'pull_request'
       run: dotnet pack --configuration Release --include-symbols --include-source --no-build --no-restore --output "${{env.BUILD_PATH}}"
 
     - name: Upload Packages
       if: success() && github.event_name != 'pull_request'
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: packages
         path: '${{env.BUILD_PATH}}'
@@ -89,7 +86,7 @@ jobs:
 
     steps:
     - name: Download Artifact
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: packages
 

README.md

@@ -40,7 +40,7 @@ Replace `<ConnectionString>` with a valid database connection string.
 
 ### Generation Output
 
-The `generate` command will create the follow files and directory structure by default.  The root directory defaults to the current working directory.  Most of the output names and locations can be customized in the [configuration file](https://efg.loresoft.com/en/latest/configuration/)
+The `generate` command will create the follow files and directory structure by default.  The root directory defaults to the current working directory.  Most of the output names and locations can be customized in the [configuration file](https://efg.loresoft.com/configuration/)
 
 #### Data Context Output
 
@@ -56,7 +56,7 @@ The mapping directory contains a fluent mapping class to map each entity to its
 
 ## Initialize Command
 
-The `initialize` command is used to create the configuration yaml file and optionally set the [connection string](https://efg.loresoft.com/en/latest/connectionString/). The configuration file has many options to configure the generated output.  See the [configuration file](https://efg.loresoft.com/en/latest/configuration/) documentation for more details.
+The `initialize` command is used to create the configuration yaml file and optionally set the [connection string](https://efg.loresoft.com/connectionString/). The configuration file has many options to configure the generated output.  See the [configuration file](https://efg.loresoft.com/configuration/) documentation for more details.
 
 The following command will create an initial `generation.yaml` configuration file as well as setting a user secret to store the connection string.
 
@@ -129,7 +129,7 @@ Entity Framework Core Generator supports the following databases.
 - MySQL
 - Sqlite
 
-The provider can be set via command line or via the [configuration file](https://efg.loresoft.com/en/latest/configuration/).
+The provider can be set via command line or via the [configuration file](https://efg.loresoft.com/configuration/).
 
 Set via command line
 
@@ -151,10 +151,17 @@ The database schema is loaded from the metadata model factory implementation of
 
 ## View Models
 
-Entity Framework Core Generator supports generating [Read](https://efg.loresoft.com/en/latest/md/read/), [Create](https://efg.loresoft.com/en/latest/md/create/) and [Update](https://efg.loresoft.com/en/latest/md/update/) view models from an entity.  Many projects rely on view models to shape data.  The model templates can be used to quickly get the basic view models created.  The model templates also support regeneration so any database change can easily be sync'd to the view models.  
+Entity Framework Core Generator supports generating [Read](https://efg.loresoft.com/md/read/), [Create](https://efg.loresoft.com/md/create/) and [Update](https://efg.loresoft.com/md/update/) view models from an entity.  Many projects rely on view models to shape data.  The model templates can be used to quickly get the basic view models created.  The model templates also support regeneration so any database change can easily be sync'd to the view models.  
 
 ## Change Log
 
+### Version 6.0
+
+- upgrade to .net 8
+- add option to turn off temporal table mapping
+- add rowversion options, ByteArray|Long|ULong 
+- add script template merge
+
 ### Version 5.0
 
 - add support for navigation property renames

docs/commands.md

@@ -20,7 +20,7 @@ Options:
 
 Example:
 
-efg initialize initialize -c "Data Source=(local);Initial Catalog=Tracker;Integrated Security=True"
+efg initialize -c "Data Source=(local);Initial Catalog=Tracker;Integrated Security=True"
 ```
 
 ## Generate Command
@@ -44,4 +44,4 @@ Options:
 Example:
 
 efg generate
-```
+```

docs/configuration.md

@@ -102,6 +102,9 @@ data:
     directory: '{Project.Directory}\Data\Mapping'   # the mapping class output directory
     #include XML documentation
     document: false
+    
+    temporal: false                                 # if temporal table mapping is enabled. Default true
+    rowVersion: ByteArray|Long|ULong                # How row versions should be mapped. Default ByteArray
 
   # query extension class file configuration
   query:
@@ -191,6 +194,7 @@ script:
       namespace: '{Project.Namespace}.Domain.Context'  
       baseClass: ContextScriptBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
   # collection of script template with current Entity as a variable
   entity:
     - templatePath: '.\templates\entity.csx'           # path to script file
@@ -199,6 +203,7 @@ script:
       namespace: '{Project.Namespace}.Domain.Entity'  
       baseClass: EntityScriptBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
   # collection script template with current Model as a variable
   model:
     - templatePath: '.\templates\model.csx'            # path to script file
@@ -207,10 +212,12 @@ script:
       namespace: '{Project.Namespace}.Domain.Models'  
       baseClass: ModelScriptBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
     - templatePath: '.\templates\sample.csx'           # path to script file
       fileName: '{Model.Name}Sample.cs'                # filename to save script output
       directory: '{Project.Directory}\Domain\Models'   # directory to save script output
       namespace: '{Project.Namespace}.Domain.Models'  
       baseClass: ModelSampleBase
       overwrite: true                                  # overwrite existing file
+      merge: true                                      # merge regions with existing file
 ```

docs/connectionString.md

@@ -45,7 +45,6 @@ The `userSecretsId` can be shared with your .NET Core Project.
 
 ```XML
 <PropertyGroup>
-  <TargetFramework>netcoreapp2.1</TargetFramework>
   <UserSecretsId>984ef0cf-2b22-4fd1-876d-e01499da4c1f</UserSecretsId>
 </PropertyGroup>
 ```

docs/ef/mapping.md

@@ -134,6 +134,14 @@ The directory location to write the source file. *Variables Supported*
 
 Include XML documentation for the generated class.  Default: `false`
 
+### temporal
+
+If temporal table mapping is enabled. Default true
+
+### rowVersion
+
+How row versions should be mapped. Default ByteArray. ByteArray|Long|ULong
+
 ## Regeneration
 
 The entity template has one region that is replaced on regeneration.

docs/scripts.md

@@ -185,12 +185,14 @@ script:
     - templatePath: '.\Templates\entity-yaml.csx'
       fileName: '{Entity.Name}.yml'
       directory: '{Project.Directory}\Yaml\Entity'
-      overwrite: true
+      overwrite: false
+      merge: true
   model:
     - templatePath: '.\Templates\model-yaml.csx'
       fileName: '{Model.Name}.yml'
       directory: '{Project.Directory}\Yaml\Model'
-      overwrite: true
+      overwrite: false
+      merge: true
 ```
 
 ### TemplatePath
@@ -216,3 +218,7 @@ The directory location to write script template output. *Variables Supported*
 #### Overwrite
 
 Flag indicating whether to overwrite existing file. Default: `false`
+
+#### Merge
+
+Flag indicating whether to merge regions with existing file. Default: `false`

mkdocs.yml

@@ -1,30 +1,40 @@
 site_name: Entity Framework Core Generator
-theme: readthedocs
+theme: material
 repo_url: https://github.com/loresoft/EntityFrameworkCore.Generator
 
-pages:
-- Home: index.md
+nav:
+  - Home: index.md
 
-- Quick Start: quickStart.md
-- Database Connection: connectionString.md
-- Database Providers: providers.md
-- Regeneration: regeneration.md
-- Generation Configuration: configuration.md
-- Configuration Variables: variables.md
-- Command Line Reference: commands.md
+  - Quick Start: quickStart.md
+  - Database Connection: connectionString.md
+  - Database Providers: providers.md
+  - Regeneration: regeneration.md
+  - Configuration File: configuration.md
+  - Configuration Variables: variables.md
+  - Command Line Reference: commands.md
 
-- EntityFramework Templates:
-    - Data Context: ef/dataContext.md
-    - Entity: ef/entity.md
-    - Mapping: ef/mapping.md
-    - Extensions: ef/extensions.md
+  - EntityFramework Templates:
+      - Data Context: ef/dataContext.md
+      - Entity: ef/entity.md
+      - Mapping: ef/mapping.md
+      - Extensions: ef/extensions.md
 
-- Model Templates:
-    - Shared Configuration: md/shared.md
-    - Read Model: md/read.md
-    - Create Model: md/create.md
-    - Update Model: md/update.md
-    - Validation: md/validation.md
-    - Object Mapper: md/mapper.md
+  - Model Templates:
+      - Shared Configuration: md/shared.md
+      - Read Model: md/read.md
+      - Create Model: md/create.md
+      - Update Model: md/update.md
+      - Validation: md/validation.md
+      - Object Mapper: md/mapper.md
 
-- Script Templates: scripts.md
+  - Script Templates: scripts.md
+
+markdown_extensions:
+  - tables
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences