Skip to content

Commit

Permalink
Merge pull request #1 from snovak7/main
Browse files Browse the repository at this point in the history
Preparations for release v0.1.0
  • Loading branch information
snovak7 authored Apr 15, 2023
2 parents 72f092e + 279fc24 commit fb43b7d
Show file tree
Hide file tree
Showing 12 changed files with 177 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[*]
charset = utf-8
insert_final_newline = true
31 changes: 31 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: dotnet build

on: [push]

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
dotnet-version: [ '7.0.x' ]
steps:
- uses: actions/checkout@v3
with:
fetch-depth: '0'
- name: Setup .NET Core SDK ${{ matrix.dotnet-version }}
uses: actions/setup-dotnet@v3
with:
dotnet-version: ${{ matrix.dotnet-version }}
- name: Restore .NET Packages
run: dotnet restore
- name: Build .NET Solution
run: dotnet build --configuration Release --no-restore
- name: Pack .NET Solution
run: dotnet pack --no-build --output pack/
- name: Publish .NET Solution to GitHub Packages
continue-on-error: true
run: dotnet nuget push pack/* --api-key ${{ secrets.GITHUB_TOKEN }} --source "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json"
- name: Publish .NET Solution to NuGet.org
continue-on-error: true
run: dotnet nuget push pack/* --api-key ${{ secrets.NUGET_ORG_KEY }} --source nuget

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -348,3 +348,6 @@ MigrationBackup/

# Ionide (cross platform F# VS Code tools) working folder
.ionide/

# JetBrains
.idea/
7 changes: 7 additions & 0 deletions Directory.Build.props
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<Project>
<PropertyGroup>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/escendit/Escendit.Tools.SourceLink.GitHub</RepositoryUrl>
</PropertyGroup>
</Project>
13 changes: 13 additions & 0 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<Project>
<ItemGroup>
<PackageReference Include="Escendit.Tools.Branding" Version="1.0.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="GitVersion.MsBuild" Version="5.12.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>
</Project>
27 changes: 27 additions & 0 deletions Escendit.Tools.SourceLink.GitHub.sln
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.0.31903.59
MinimumVisualStudioVersion = 10.0.40219.1
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{CFBA9EFD-D43A-4DDB-9DBF-6D0FDFB59537}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Escendit.Tools.SourceLink.GitHub", "src\Escendit.Tools.SourceLink.GitHub\Escendit.Tools.SourceLink.GitHub.csproj", "{EB9CA336-4D65-44DD-8EE3-EFECD88E4991}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{EB9CA336-4D65-44DD-8EE3-EFECD88E4991} = {CFBA9EFD-D43A-4DDB-9DBF-6D0FDFB59537}
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{EB9CA336-4D65-44DD-8EE3-EFECD88E4991}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{EB9CA336-4D65-44DD-8EE3-EFECD88E4991}.Debug|Any CPU.Build.0 = Debug|Any CPU
{EB9CA336-4D65-44DD-8EE3-EFECD88E4991}.Release|Any CPU.ActiveCfg = Release|Any CPU
{EB9CA336-4D65-44DD-8EE3-EFECD88E4991}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
EndGlobal
4 changes: 4 additions & 0 deletions GitVersion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
branches:
master:
mode: ContinuousDeployment
tag: rc
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# Escendit.Tools.SourceLink.GitHub
GitHub defaults for SourceLink
# NuGet Package: Escendit.Tools.SourceLink.GitHub
.NET NuGet package
that simplifies the process of integrating [SourceLink](https://github.com/dotnet/sourcelink) into your project.
SourceLink provides a mechanism for debugging optimized code
without sacrificing security by allowing you to use the actual source code for debugging,
rather than decompiled code.

## Installation
To install `Escendit.Tools.SourceLink.GitHub`,
you can use the NuGet Package Manager or run the following command in the Package Manager Console:

```shell
PM> Install-Package Escendit.Tools.SourceLink.GitHub
```
Or you can search for "Escendit.Tools.SourceLink.GitHub"
in the NuGet Package Manager UI and install it from there.

## Usage
`Escendit.Tools.SourceLink.GitHub` provides properties for SourceLink
that you can use in your .NET projects.
These default values are intended to simplify the process of integrating SourceLink into your project,
by source-linking files from GitHub repository to your NuGet package and can be overridden as needed.

## Limitations
Using the current git technology stack, there are limitations in being able
to access source files of private repositories due to the security mechanisms in place.

## Contributing
If you find a bug or have a feature request, please create an issue in the GitHub repository.

To contribute code, fork the repository and submit a pull request.
Please ensure that your code follows the project's coding standards and is thoroughly tested.

## License
This package is released under the MIT License. See the LICENSE.txt file for details.

5 changes: 5 additions & 0 deletions global.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"sdk": {
"version": "7.0.100"
}
}
7 changes: 7 additions & 0 deletions nuget.config
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear />
<add key="nuget" value="https://api.nuget.org/v3/index.json" />
</packageSources>
</configuration>
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="utf-8" ?>
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<DevelopmentDependency>true</DevelopmentDependency>
<TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
<NoWarn>$(NoWarn);NU5128</NoWarn>
<IsPackable>true</IsPackable>
<IncludeBuildOutput>false</IncludeBuildOutput>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
<Description>Provides properties for SourceLink to simplify the integration with GitHub.</Description>
<PackageTags>sourcelink;source;link;github;defaults</PackageTags>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Escendit.Tools.SourceLink.Common" Version="0.1.0-rc.14">
<PrivateAssets>runtime; build; native; contentfiles</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
<PrivateAssets>runtime; build; native; contentfiles</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>
<ItemGroup>
<!-- TFM -->
<None Pack="true" PackagePath="build" Include="Escendit.Tools.SourceLink.GitHub.props" />
<!-- TFMs -->
<None Pack="true" PackagePath="buildMultiTargeting" Include="Escendit.Tools.SourceLink.GitHub.props" />
<!-- Transitive -->
<None Pack="true" PackagePath="buildTransitive" Include="Escendit.Tools.SourceLink.GitHub.props" />
<!-- README -->
<None Pack="true" PackagePath="" Include="$(SolutionDir)/README.md" />
</ItemGroup>
</Project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8" ?>
<Project>
<PropertyGroup>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
<ContinuousIntegrationBuild Condition="'$(GITHUB_ACTIONS)' == 'true'">true</ContinuousIntegrationBuild>
</PropertyGroup>
</Project>

0 comments on commit fb43b7d

Please sign in to comment.