Skip to content
This repository has been archived by the owner on Sep 23, 2023. It is now read-only.

Release v0.2.1 #2

Merged
merged 13 commits into from
Sep 23, 2023
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
indent_style = space
indent_size = 4
tab_width = 4
end_of_line = crlf
end_of_line = lf
charset = utf-8-bom
trim_trailing_whitespace = true
insert_final_newline = true
Expand Down
2 changes: 0 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
* text=auto eol=lf

*.cs text eol=crlf
12 changes: 12 additions & 0 deletions .github/workflows/check-eol.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Check End-of-Line Sequences
run-name: Check End-of-Line Sequences

on:
push:
branches: [ master, dev ]
pull_request:
branches: [ master, dev ]

jobs:
check-eol:
uses: Arthri/check-eol/.github/workflows/check-eol.yml@v1
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ on:

jobs:
deploy:
uses: Arthri/deploy_nuget/.github/workflows/deploy.yml@v1
uses: Arthri/deploy-nuget/.github/workflows/deploy.yml@v1
secrets:
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
NUGET-API-KEY: ${{ secrets.NUGET_API_KEY }}
with:
changelog: ${{ github.event.release.body }}
version: ${{ github.event.release.tag_name }}
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ on:
types:
- closed
- edited
- labeled
- opened
- unlabeled
branches:
- master

jobs:
handle_release_request:
handle-release-request:
name: ${{ github.event.action == 'closed' && 'Resolve ' || 'Verify ' }}Release Request
permissions:
contents: write
uses: Arthri/release_request/.github/workflows/release_request.yml@v1
uses: Arthri/release-request/.github/workflows/release-request.yml@v1
3 changes: 0 additions & 3 deletions Belp.SDK.Common.sln
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Belp.SDK.Common", "src\Belp
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{3C37E783-7F68-404D-BB6A-1A6C938B7E11}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{3C37E783-7F68-404D-BB6A-1A6C938B7E11}.Debug|Any CPU.Build.0 = Debug|Any CPU
{3C37E783-7F68-404D-BB6A-1A6C938B7E11}.Release|Any CPU.ActiveCfg = Release|Any CPU
{3C37E783-7F68-404D-BB6A-1A6C938B7E11}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Belp.SDK.Common
The base of all Belp SDKs: contains common features shared by Belp SDKs.

> [!IMPORTANT]
> Remaining code has been merged with Belp.SDK.Packinf and Belp.SDK.Common discontinued.

## Installation
It is not recommended to install Belp.SDK.Common directly.

### Requirements
- A project written in SDK-style. This includes any project for .NET Core(or newer) or .NET 5(or newer).

### Install in Project Manually
### Install using an Editor
1. Locate the project file(for example, `Project.csproj`, `Project.fsproj`).
1. Open the project file in an editor.
1. Add the [`<Sdk Name="Belp.SDK.Common" Version="<VERSION>" />`](https://learn.microsoft.com/en-us/visualstudio/msbuild/sdk-element-msbuild) element under the root `<Project>` element.
1. Add a new `Sdk` element under the root `Project` element with the `Name` attribute set to `Belp.SDK.Common` and the `Version` attribute set to `1.0.0`. For example, `<Sdk Name="Belp.SDK.Common" Version="1.0.0" />`.

## Usage

Expand All @@ -23,23 +26,20 @@ It is not recommended to install Belp.SDK.Common directly.

The NuGet package will be pushed to a source named `tmp`. If the source doesn't exist, create a new local NuGet source with `dotnet nuget add source <SOURCE_PATH> --name tmp`.

### Output Packed Package Path to GitHub Actions
Run `dotnet build`, `dotnet pack`, `dotnet msbuild`, or other msbuild aliases with the `-p:BELP_EXPOSE_CI_VARIABLES=true` argument.

## Development

### Prerequisites
- Install .NET 7.0 SDK version 7.0.100 or newer.
- Install the .NET 7.0 SDK version 7.0.100 or newer.

### Building (with Visual Studio)
### Building with Visual Studio
1. Open `Belp.SDK.Common.sln`.
1. Open the Solution Explorer.
1. Right click on the project `Belp.SDK.Common` in the Solution Explorer.
1. Click on `Pack`.

### Building (with .NET CLI)
### Building with .NET CLI
1. Open a terminal in the repository root.
1. Run `dotnet pack`

### Output
The output is located in `src/Belp.SDK.Common/Belp.SDK.Common/bin/<CONFIGURATION>`.
By default, the output is located in `src/Belp.SDK.Common/Belp.SDK.Common/bin/Release/`.
Empty file.
11 changes: 2 additions & 9 deletions src/Belp.SDK.Common/Belp.SDK.Common.csproj
Original file line number Diff line number Diff line change
@@ -1,26 +1,19 @@
<Project Sdk="Belp.SDK.PackOnly/0.1.0">
<Project Sdk="Belp.SDK.PackOnly/0.4.0">

<!-- Package Information -->
<PropertyGroup>
<Authors>Arthri</Authors>
<Copyright>Copyright © 2023 Arthri</Copyright>
<Description>The base of all Belp SDKs: contains common features shared by Belp SDKs.</Description>
<DevelopmentDependency>true</DevelopmentDependency>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/Arthri/Belp.SDK.Common/</PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageTags>msbuild;sdk</PackageTags>
<Product>Belp</Product>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<Title>Belp Common SDK</Title>
</PropertyGroup>



<!-- Package Assets Configuration -->
<ItemGroup>
<None Include="Assets\**\*" Pack="true" PackagePath="\" />
<None Include="..\..\README.md" Pack="true" PackagePath="\" />
<CopyrightOwner Include="Arthri" Years="2023" />
</ItemGroup>


Expand Down