Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ignatandrei/RSCG_AMS
a Roslyn Source Code Generator for About My Software
https://github.com/ignatandrei/RSCG_AMS
Last synced: about 1 month ago
JSON representation
a Roslyn Source Code Generator for About My Software
- Host: GitHub
- URL: https://github.com/ignatandrei/RSCG_AMS
- Owner: ignatandrei
- License: mit
- Created: 2021-06-23T18:12:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-21T12:52:31.000Z (over 1 year ago)
- Last Synced: 2024-04-27T07:40:53.778Z (8 months ago)
- Language: C#
- Homepage: https://ignatandrei.github.io/RSCG_AMS/
- Size: 1.49 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - https://github.com/ignatandrei/RSCG_AMS
README
# RSCG_AMS
a Roslyn Source Code Generator for About My Software
You will obtain
( See online at https://netcoreblockly.herokuapp.com/ams )
[](https://www.nuget.org/packages/AMS_Base/)
[](https://www.nuget.org/packages/RSCG_AMS/)
[](https://www.nuget.org/packages/AMSWebAPI/)
[](https://github.com/ignatandrei/RSCG_AMS/actions/workflows/dotnet.yml)
## How to use
### For Console or DLL
Add to the csproj 2023.5.21.1551
```xml
```
And access like this:
```csharp
var amsAll = AboutMySoftware.AllDefinitions;
foreach (var amsKV in amsAll)
{
var ams = amsKV.Value;
Console.WriteLine($"{amsKV.Key}.{nameof(ams.AssemblyName)} : {ams.AssemblyName}");
Console.WriteLine($"{amsKV.Key}.{nameof(ams.DateGenerated)} : {ams.DateGenerated}");
Console.WriteLine($"{amsKV.Key}.{nameof(ams.CommitId)} : {ams.CommitId}");
Console.WriteLine($"{amsKV.Key}.{nameof(ams.RepoUrl)} : {ams.RepoUrl}");
}
```
### For Web applications
Add to the csproj
```xml
```
And in the Startup.cs put
```csharp
//above the namespace : using AMSWebAPI;
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
endpoints.UseAMS();
});
```
The access /ams/all ( for json) or /ams/index ( for html)
## Adding releases on date
For adding releases between dates use the following codes:
```csharp
using AMS_Base;
[assembly:VersionReleased(Name="PreviousReleases",ISODateTime ="2022-03-31",recordData = RecordData.Merges)]
[assembly: VersionReleased(Name = "WithVersioning", ISODateTime = "2022-04-02", recordData = RecordData.Merges)]
[assembly: AMS_Base.VersionReleased(Name = "FutureRelease", ISODateTime = "9999-04-16", recordData = AMS_Base.RecordData.Merges)]
```
## Detecting that you are in a CI build
Put into the .csproj
```xml
true
$(BaseIntermediateOutputPath)GeneratedX
```
In the obj folder see the GeneratedX folder, then AMS folder, than AMS.AMSVersion folder, then edit the .cs file with notepad
you will see something like
```csharp
public class XAboutMySoftware_digits
```
Please see what are the digits
In your code put someething like this
```csharp
bool IsInCI = new XAboutMySoftware_digits().IsInCI;
builder.Services.AddDbContextFactory(
options =>
{
if (IsInCI)
{
var cn = builder.Configuration.GetConnectionString("DefaultConnection");
options.UseSqlServer(cn);
}
else
{
var cn = "Data Source=Tilt.db";
options.UseSqlite(cn);
}
}
)
;
```
## Modifying the subject
Add to the csproj the following
```xml
true
$(BaseIntermediateOutputPath)GeneratedX
AMSInterpreter.MergeAnalyzer
```
and add the following code to a class
```csharp
public static string MergeAnalyzer(string RepoUrl,string CommitId, string Author, DateTime ReleaseDate, string Subject)
{
try
{
/*{
//modify the subject
string regex = @"^Merge\ pull\ request\ \#(?\d+)\ from\ (?.+?)$";
RegexOptions options = RegexOptions.Multiline;
string input = Subject;
MatchCollection matches = Regex.Matches(input, regex, options);
foreach (Match match in matches)
{
return $"Issue ID: {RepoUrl}/issues/{match.Groups["issueID"].Value} branch: {match.Groups["branch"].Value}"; ;
}
return Subject;
}*/
}
catch (Exception ex)
{
return $"{CommitId} {ex.Message}";
}
}
```
## Diagnostics
//TODO: Add more explanations here
```xml
true
true
$(BaseIntermediateOutputPath)GeneratedX
AMSInterpreter.MergeAnalyzer
```
## CI settings
For GitLab:
For GitHub actions:
```yaml
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
```
## How it is built
The AMS_Base project / nuget is containing the definition
The RSCG_AMS project / nuget generates the code for having , in CI , the C# class with the commit / Repo / date / other details.
The AMSWebAPI project / nuget generates the code for endpoints : /ams/index.html and /ams/all ( for json )
See more at http://msprogrammer.serviciipeweb.ro/category/ams/
## TBD:
More about https://github.com/ignatandrei/RSCG_AMS/issues/27
```xml
log --merges --pretty='%an|%ai|%H|%s
```
More about Angular - to display ams - see src/Angular
# More Roslyn Source Code Generators
You can find more RSCG with examples at [Roslyn Source Code Generators](https://ignatandrei.github.io/RSCG_Examples/v2/)