Merged
Conversation
This commit introduces a `<Copyright>` element to the project files of multiple ETL examples. Each project file now specifies copyright information in the format `Copyright {copyright year} {author}`. The updates are applied consistently across all relevant project files, enhancing documentation and compliance.
- Added binary files `ETL-Abstractions.ico` and `ETL-Abstractions.png`. - Removed the obsolete `ETL.png` file. - Cleaned up the `TargetFrameworks` in `Wolfgang.Etl.Abstractions.csproj`. - Updated `PackageIcon` to `ETL-Abstractions.png` and added `ApplicationIcon`. - Introduced `GenerateDocumentationFile` and `PackageTags` properties. - Modified `ItemGroup` to include new icon files and removed references to the old PNG.
- Added XML documentation to `LoaderBase.cs` for clarity on the maximum items to load. - Introduced a new `Report` class in `Report.cs` with validation for the current count and documentation. - Updated `TransformerBase.cs` with documentation for `TransformWorkerAsync` and added a new abstract method `CreateProgressReport`.
Updated the version number from 0.5.0 to 0.6.0 in the Wolfgang.Etl.Abstractions.csproj file.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds copyright information and icon updates to the project, bumps the version to 0.6.0, and introduces a new Report class for progress reporting in ETL operations.
- Added standardized copyright information across all project files
- Updated package icon from
ETL.pngtoETL-Abstractions.pngand added application icon - Introduced new
Reportclass as a base class for progress reporting with current count tracking
Reviewed Changes
Copilot reviewed 13 out of 18 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Wolfgang.Etl.Abstractions/Wolfgang.Etl.Abstractions.csproj | Updated version to 0.6.0, changed copyright format, updated package icon references, and added new project metadata |
| src/Wolfgang.Etl.Abstractions/Report.cs | Added new Report record class for tracking current count in ETL progress reporting |
| src/Wolfgang.Etl.Abstractions/TransformerBase.cs | Added XML documentation for protected abstract methods |
| src/Wolfgang.Etl.Abstractions/LoaderBase.cs | Removed extra blank line for code formatting |
| tests/Wolfgang.Etl.Abstractions.Tests.Unit/Wolfgang.Etl.Abstractions.Tests.Unit.csproj | Added copyright information to test project |
| Multiple example projects | Added copyright information to all example project files |
| <Description>Contains interfaces and base classes used to build ETL applications</Description> | ||
| <Copyright>2025</Copyright> | ||
| <PackageProjectUrl>https://github.com/Chris-Wolfgang/ETL-Abstractions</PackageProjectUrl> | ||
| <Copyright>Copyright {copyright year} {author}</Copyright> |
There was a problem hiding this comment.
The copyright field contains placeholder text '{copyright year} {author}' instead of actual values. This should be replaced with the actual copyright year and author name.
Suggested change
| <Copyright>Copyright {copyright year} {author}</Copyright> | |
| <Copyright>Copyright 2024 Chris Wolfgang</Copyright> |
|
|
||
| <IsPackable>false</IsPackable> | ||
| <IsTestProject>true</IsTestProject> | ||
| <Copyright>Copyright {copyright year} {author}</Copyright> |
There was a problem hiding this comment.
The copyright field contains placeholder text '{copyright year} {author}' instead of actual values. This should be replaced with the actual copyright year and author name.
Suggested change
| <Copyright>Copyright {copyright year} {author}</Copyright> | |
| <Copyright>Copyright 2024 Wolfgang</Copyright> |
| /// <param name="token"> | ||
| /// A CancellationToken to observe while waiting for the task to complete. | ||
| /// </param> | ||
| /// <returns></returns> |
There was a problem hiding this comment.
The returns tag is empty and should describe what the method returns. It should specify that it returns an IAsyncEnumerable containing the transformed items.
Suggested change
| /// <returns></returns> | |
| /// <returns> | |
| /// An <see cref="IAsyncEnumerable{TDestination}"/> containing the transformed items. | |
| /// </returns> |
| /// <summary> | ||
| /// Constructs a new instance of the <see cref="Report"/> class with the specified current count. | ||
| /// </summary> | ||
| /// <param name="currentCount"></param> |
There was a problem hiding this comment.
The param documentation for 'currentCount' is missing a description. It should explain what the current count represents.
Suggested change
| /// <param name="currentCount"></param> | |
| /// <param name="currentCount">The number of items that have been processed so far in the ETL process.</param> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.