Skip to content

Commit 4d8027f

Browse files
FredericAnthierensFredericAnthierens
committed
Add project files.
1 parent 7ce7a14 commit 4d8027f

16 files changed

+1301
-0
lines changed

‎.editorconfig

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
indent_style = tab
5+
indent_size = 4
6+
tab_width = 4
7+
end_of_line = crlf
8+
trim_trailing_whitespace = true
9+
10+
[*.cs]
11+
dotnet_sort_system_directives_first = true

‎.github/dependabot.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "nuget" # See documentation for possible values
9+
# directory: "/"
10+
directories: # Use this if you have no .sln file in your root.
11+
- "*"
12+
schedule:
13+
interval: "weekly"
14+
ignore:
15+
# FluentAssertions equal to or higher than 8.0.0 are a different license, which requires payment
16+
- dependency-name: "FluentAssertions"
17+
versions: [ ">=8.0.0" ]
18+
19+
# DevPacks represents the DMA on which to compile. Doesn't make sense to always be on the latest version.
20+
- dependency-name: "Skyline.DataMiner.Files.*"
21+
- dependency-name: "Skyline.DataMiner.Dev.*"
22+
groups:
23+
all-dependencies:
24+
patterns:
25+
- "*"

‎.github/workflows/complete.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Skyline Reusable Quality Workflow
2+
3+
# Controls when the workflow will run
4+
on:
5+
# Triggers the workflow on push or pull request events but only for the master branch
6+
push:
7+
branches: []
8+
tags:
9+
- "[0-9]+.[0-9]+.[0-9]+.[0-9]+"
10+
- "[0-9]+.[0-9]+.[0-9]+.[0-9]+-**"
11+
- "[0-9]+.[0-9]+.[0-9]+"
12+
- "[0-9]+.[0-9]+.[0-9]+-**"
13+
14+
# Allows you to run this workflow manually from the Actions tab
15+
workflow_dispatch:
16+
17+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
18+
jobs:
19+
20+
CI:
21+
uses: SkylineCommunications/_ReusableWorkflows/.github/workflows/DataMiner App Packages Master Workflow.yml@main
22+
with:
23+
configuration: Release
24+
referenceName: ${{ github.ref_name }}
25+
runNumber: ${{ github.run_number }}
26+
referenceType: ${{ github.ref_type }}
27+
repository: ${{ github.repository }}
28+
owner: ${{ github.repository_owner }}
29+
sonarCloudProjectName: ${{ vars.SONAR_NAME }} # Go to 'https://sonarcloud.io/projects/create' and create a project. Then create a SONAR_NAME variable with the ID of the project as mentioned in the SonarCloud project URL.
30+
# solutionFilterName: "MySolutionFilter.slnf"
31+
secrets:
32+
dataminerToken: ${{ secrets.DATAMINER_TOKEN }} # The API key: generated in the DCP Admin app (https://admin.dataminer.services/) as authentication for a certain DataMiner System.
33+
sonarCloudToken: ${{ secrets.SONAR_TOKEN }} # The API key for access to SonarCloud.

‎Directory.Build.props

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<Project>
2+
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
3+
<DebugType>full</DebugType>
4+
<CodeAnalysisRuleSet>..\Internal\Code Analysis\qaction-debug.ruleset</CodeAnalysisRuleSet>
5+
</PropertyGroup>
6+
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
7+
<DebugType>pdbonly</DebugType>
8+
<CodeAnalysisRuleSet>..\Internal\Code Analysis\qaction-release.ruleset</CodeAnalysisRuleSet>
9+
</PropertyGroup>
10+
<ItemGroup>
11+
<AdditionalFiles Include="..\Internal\Code Analysis\stylecop.json">
12+
<Link>Properties\stylecop.json</Link>
13+
</AdditionalFiles>
14+
<Content Include="..\.editorconfig">
15+
<Link>Properties\.editorconfig</Link>
16+
</Content>
17+
</ItemGroup>
18+
<ItemGroup>
19+
<PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
20+
<PrivateAssets>all</PrivateAssets>
21+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
22+
</PackageReference>
23+
</ItemGroup>
24+
</Project>

‎FAN_MyAdHocDataSource.sln

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.12.35728.132 d17.12
5+
MinimumVisualStudioVersion = 10.0.40219.1
6+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FAN_MyAdHocDataSource", "FAN_MyAdHocDataSource\FAN_MyAdHocDataSource.csproj", "{34AD5F74-1397-4579-ADE9-CF53DD8C8218}"
7+
EndProject
8+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Internal", "Internal", "{98EF175C-52EF-47E9-B009-4E9B45F3EB8B}"
9+
EndProject
10+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Code Analysis", "Code Analysis", "{59DFDDA1-4948-486A-81C5-BEAF27DE378D}"
11+
ProjectSection(SolutionItems) = preProject
12+
Internal\Code Analysis\qaction-debug.ruleset = Internal\Code Analysis\qaction-debug.ruleset
13+
Internal\Code Analysis\qaction-release.ruleset = Internal\Code Analysis\qaction-release.ruleset
14+
Internal\Code Analysis\stylecop.json = Internal\Code Analysis\stylecop.json
15+
EndProjectSection
16+
EndProject
17+
Global
18+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
19+
Debug|Any CPU = Debug|Any CPU
20+
Release|Any CPU = Release|Any CPU
21+
EndGlobalSection
22+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
23+
{34AD5F74-1397-4579-ADE9-CF53DD8C8218}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
24+
{34AD5F74-1397-4579-ADE9-CF53DD8C8218}.Debug|Any CPU.Build.0 = Debug|Any CPU
25+
{34AD5F74-1397-4579-ADE9-CF53DD8C8218}.Release|Any CPU.ActiveCfg = Release|Any CPU
26+
{34AD5F74-1397-4579-ADE9-CF53DD8C8218}.Release|Any CPU.Build.0 = Release|Any CPU
27+
EndGlobalSection
28+
GlobalSection(SolutionProperties) = preSolution
29+
HideSolutionNode = FALSE
30+
EndGlobalSection
31+
GlobalSection(NestedProjects) = preSolution
32+
{59DFDDA1-4948-486A-81C5-BEAF27DE378D} = {98EF175C-52EF-47E9-B009-4E9B45F3EB8B}
33+
EndGlobalSection
34+
EndGlobal

‎FAN_MyAdHocDataSource/CatalogInformation/Images/wip.png

34.6 KB
Loading

‎FAN_MyAdHocDataSource/CatalogInformation/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# FAN_MyAdHocDataSource
2+
3+
![WIP](./Images/wip.png)

‎FAN_MyAdHocDataSource/CatalogInformation/manifest.yml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# [Required]
2+
# Possible values for the Catalog item that can be deployed on a DataMiner System:
3+
# - Automation: If the Catalog item is a general-purpose DataMiner Automation script.
4+
# - Ad Hoc Data Source: If the Catalog item is a DataMiner Automation script designed for an ad hoc data source integration.
5+
# - ChatOps Extension: If the Catalog item is a DataMiner Automation script designed as a ChatOps extension.
6+
# - Connector: If the Catalog item is a DataMiner XML connector.
7+
# - Custom Solution: If the Catalog item is a DataMiner Solution.
8+
# - Data Query: If the Catalog item is a GQI data query.
9+
# - Data Transformer: Includes a data transformer that enables you to modify data using a GQI data query before making it available to users in low-code apps or dashboards.
10+
# - Dashboard: If the Catalog item is a DataMiner dashboard.
11+
# - DevTool: If the Catalog item is a DevTool.
12+
# - Learning & Sample: If the Catalog item is a sample.
13+
# - Product Solution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific product.
14+
# - Scripted Connector: If the Catalog item is a DataMiner scripted connector.
15+
# - Standard Solution: If the Catalog item is a DataMiner Solution that is an out-of-the-box solution for a specific use case or application.
16+
# - System Health: If the Catalog item is intended to monitor the health of a system.
17+
# - User-Defined API: If the Catalog item is a DataMiner Automation script designed as a user-defined API.
18+
# - Visual Overview: If the Catalog item is a Microsoft Visio design.
19+
#
20+
type: Custom Solution
21+
# [Required]
22+
# The ID of the Catalog item.
23+
# All registered versions for the same ID are shown together in the Catalog.
24+
# This ID cannot be changed.
25+
# If the ID is not filled in, the registration will fail with HTTP status code 500.
26+
# If the ID is filled in but does not exist yet, a new Catalog item will be registered with this ID.
27+
# If the ID is filled in but does exist, properties of the item will be overwritten.
28+
# Must be a valid GUID.
29+
id: ec25fc22-7698-4245-80eb-2a0ddb82921f
30+
# [Required]
31+
# The human-friendly name of the Catalog item.
32+
# Can be changed at any time.
33+
# Max length: 100 characters.
34+
# Cannot contain newlines.
35+
# Cannot contain leading or trailing whitespace characters.
36+
title: FAN_MyAdHocDataSource
37+
# [Optional]
38+
# General information about the Catalog item.
39+
# Max length: 100,000 characters
40+
short_description: This is a custom solution for DataMiner.
41+
# [Optional]
42+
# A valid URL that points to the source code.
43+
# A valid URL
44+
# Max length: 2048 characters
45+
# Note: When Skyline Communications Reusable GitHub workflows are used, this will be automatically filled in.
46+
source_code_url:
47+
# [Optional]
48+
# A valid URL that points to documentation.
49+
# A valid URL
50+
# Max length: 2048 characters
51+
# Note: When Skyline Communications Reusable GitHub workflows are used, this will be automatically filled in.
52+
documentation_url:
53+
# [Optional]
54+
# People who are responsible for this Catalog item. Might be developers, but this is not required.
55+
# Format: 'name <email> (URL)'
56+
# The name is required; max 256 characters.
57+
# The email and URL are optional, and should be in valid email/URL formats.
58+
owners:
59+
- name: 'Fre'
60+
# [Optional]
61+
# Tags that allow you to categorize your Catalog items.
62+
# Max number of tags: 5
63+
# Max length: 50 characters.
64+
# Cannot contain newlines.
65+
# Cannot contain leading or trailing whitespace characters.
66+
tags:
67+
- dataminer

‎FAN_MyAdHocDataSource/FAN_MyAdHocDataSource.cs

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
using System;
2+
using Skyline.DataMiner.Analytics.GenericInterface;
3+
4+
namespace FANMyAdHocDataSource
5+
{
6+
/// <summary>
7+
/// Represents a data source.
8+
/// See: https://aka.dataminer.services/gqi-external-data-source for a complete example.
9+
/// </summary>
10+
[GQIMetaData(Name = "FAN_MyAdHocDataSource")]
11+
public sealed class FANMyAdHocDataSource : IGQIDataSource
12+
, IGQIOnInit
13+
, IGQIInputArguments
14+
{
15+
public OnInitOutputArgs OnInit(OnInitInputArgs args)
16+
{
17+
// Initialize the data source
18+
// See: https://aka.dataminer.services/igqioninit-oninit
19+
return default;
20+
}
21+
22+
public GQIArgument[] GetInputArguments()
23+
{
24+
// Define data source input arguments
25+
// See: https://aka.dataminer.services/igqiinputarguments-getinputarguments
26+
return Array.Empty<GQIArgument>();
27+
}
28+
29+
public OnArgumentsProcessedOutputArgs OnArgumentsProcessed(OnArgumentsProcessedInputArgs args)
30+
{
31+
// Process input argument values
32+
// See: https://aka.dataminer.services/igqiinputarguments-onargumentsprocessed
33+
return default;
34+
}
35+
36+
public GQIColumn[] GetColumns()
37+
{
38+
// Define data source columns
39+
// See: https://aka.dataminer.services/igqidatasource-getcolumns
40+
return Array.Empty<GQIColumn>();
41+
}
42+
43+
public GQIPage GetNextPage(GetNextPageInputArgs args)
44+
{
45+
// Define data source rows
46+
// See: https://aka.dataminer.services/igqidatasource-getnextpage
47+
return new GQIPage(Array.Empty<GQIRow>())
48+
{
49+
HasNextPage = false,
50+
};
51+
}
52+
}
53+
}

‎FAN_MyAdHocDataSource/FAN_MyAdHocDataSource.csproj

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<Project Sdk="Skyline.DataMiner.Sdk">
2+
<PropertyGroup>
3+
<TargetFramework>net48</TargetFramework>
4+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
5+
</PropertyGroup>
6+
<PropertyGroup>
7+
<DataMinerType>AdHocDataSource</DataMinerType>
8+
<GenerateDataMinerPackage>True</GenerateDataMinerPackage>
9+
<Version>1.0.0</Version>
10+
<VersionComment>Initial Version</VersionComment>
11+
<!-- Do NOT fill in the Organization Token here. This points to either an Environment Variable skyline__sdk__catalogpublishtoken holding the organization token or a Visual Studio User Secret holding the token. -->
12+
<CatalogPublishKeyName>skyline:sdk:catalogpublishtoken</CatalogPublishKeyName>
13+
</PropertyGroup>
14+
<ItemGroup>
15+
<PackageReference Include="Skyline.DataMiner.Dev.Automation" Version="10.2.5.5" />
16+
<PackageReference Include="Skyline.DataMiner.Utils.SecureCoding.Analyzers" Version="1.2.2">
17+
<PrivateAssets>all</PrivateAssets>
18+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
19+
</PackageReference>
20+
</ItemGroup>
21+
</Project>

‎FAN_MyAdHocDataSource/FAN_MyAdHocDataSource.xml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="utf-8" ?>
2+
<DMSScript options="272" xmlns="http://www.skyline.be/automation">
3+
<Name>FAN_MyAdHocDataSource</Name>
4+
<Description></Description>
5+
<Type>Automation</Type>
6+
<Author>Fre</Author>
7+
<CheckSets>FALSE</CheckSets>
8+
<Folder></Folder>
9+
10+
<Protocols>
11+
</Protocols>
12+
13+
<Memory>
14+
</Memory>
15+
16+
<Parameters>
17+
</Parameters>
18+
19+
<Script>
20+
<Exe id="1" type="csharp">
21+
<Value><![CDATA[[Project:FAN_MyAdHocDataSource]]]></Value>
22+
<!--<Param type="debug">true</Param>-->
23+
<Param type="preCompile">true</Param>
24+
<Param type="libraryName">FAN_MyAdHocDataSource</Param>
25+
<Message></Message>
26+
</Exe>
27+
</Script>
28+
</DMSScript>

‎FAN_MyAdHocDataSource/GettingStarted.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Getting Started with Skyline DataMiner DevOps
2+
3+
Welcome to the Skyline DataMiner DevOps environment!
4+
This quick-start guide will help you get up and running. It was auto-generated based on the initial project setup during creation.
5+
For more details and comprehensive instructions, please visit [DataMiner Docs](https://docs.dataminer.services/).
6+
7+
## Creating a DataMiner Application Package
8+
9+
This project was configured to create a `.dmapp` file every time you build the project.
10+
When you compile or build the project, you will find the generated `.dmapp` in the standard output folder, typically the `bin` folder of your project.
11+
12+
When you publish the project (see Publishing topic below), a corresponding item will be created in the online DataMiner Catalog.
13+
14+
## Migrating to a Multi-Artifact DataMiner Application Package
15+
16+
If you need to combine additional components in your `.dmapp` file, you should:
17+
18+
1. Open the `FAN_MyAdHocDataSource.csproj` file and ensure the `<GenerateDataminerPackage>` property is set to `False`.
19+
20+
2. Right-click your solution and select **Add > New Project**.
21+
22+
3. Select the **Skyline DataMiner Package Project** template.
23+
24+
Follow the provided **Getting Started** guide in the new project for further instructions.
25+
26+
## Publishing to the Catalog
27+
28+
This project was created with support for publishing to the DataMiner Catalog.
29+
You can publish your artifact either manually via the Visual Studio IDE or by setting up a CI/CD workflow.
30+
31+
## Publishing to the Catalog with Complete CI/CD Workflow
32+
33+
This project includes a comprehensive GitHub workflow that adheres to Skyline Communications' quality standards, including static code analysis, custom validation, and unit testing.
34+
35+
### Prerequisite
36+
37+
You need a **SonarCloud Organization**. If you don’t have one, you can create it [here](https://sonarcloud.io/create-organization).
38+
39+
### Steps
40+
41+
1. Create a GitHub repository by going to **Git > Create Git Repository**, selecting GitHub, and filling in the wizard before clicking **Create and Push**.
42+
43+
1. In GitHub, go to the *Actions* tab.
44+
45+
1. Click the workflow run that failed (usually called *Add project files*).
46+
47+
1. Click the "build" step that failed and read the failing error.
48+
49+
``` text
50+
Error: DATAMINER_TOKEN is not set. Release not possible!
51+
Please create or re-use an admin.dataminer.services token by visiting: https://admin.dataminer.services/.
52+
Navigate to the right Organization then go to Keys and create/find a key with permissions to Register Catalog Items.
53+
Copy the value of the token.
54+
Then set a DATAMINER_TOKEN secret in your repository settings: **Dynamic Link**
55+
```
56+
57+
You can use the links from the actual error to better address the next couple of steps.
58+
59+
1. Obtain an **Organization Key** from [admin.dataminer.services](https://admin.dataminer.services/) with the following scopes:
60+
- **Register Catalog items**
61+
- **Read Catalog items**
62+
63+
1. Add the key as a secret in your GitHub repository, by navigating to **Settings > Secrets and variables > Actions** and creating secrets or variables with the required names.
64+
65+
1. Re-run the workflow.
66+
67+
The following secrets and variables will have been added to your repository after all issues are resolved:
68+
69+
| Name | Type | Description | Setup Guide |
70+
|-----------------|---------|----------------------------------------------------|---------------------------------------------------------------------------------------------|
71+
| `DATAMINER_TOKEN` | Secret | Organization key for publishing to the Catalog | Obtain from [admin.dataminer.services](https://admin.dataminer.services/) and add it as a secret. |
72+
| `SONAR_TOKEN` | Secret | Token for SonarCloud authentication | Obtain from [SonarCloud Security](https://sonarcloud.io/account/security) and add it as a secret. |
73+
| `SONAR_NAME` | Variable | SonarCloud project ID | Visit [SonarCloud](https://sonarcloud.io/projects/create), copy the project ID, and add it as a variable. |
74+
75+
### Releasing a Version
76+
77+
1. Navigate to the **<> Code** tab in your GitHub repository.
78+
79+
1. In the menu on the right, select **Releases**.
80+
81+
1. Create a new release, select the desired version as a **tag**, and provide a title and description.
82+
83+
> [!NOTE]
84+
> The description will be visible in the DataMiner Catalog.

0 commit comments

Comments
 (0)