Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (63 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

86 lines (63 loc) · 2.61 KB

Contributing

Requirements

  • .NET SDK must be installed, either directly or from an IDE (Visual Studio 2022, Rider)

Run the dll

# builds the .NET solution
dotnet build

# runs the console app
dotnet src/ConsoleApp/bin/Debug/net9.0/almops.dll --help

Run from an IDE

  • Create at the root of the repository a file Local.runsettings with the following content:
<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
  <RunConfiguration>
    <EnvironmentVariables>
      <AlmOps__Sandbox__Organization>xxx</AlmOps__Sandbox__Organization>
      <AlmOps__Sandbox__Username>xxx</AlmOps__Sandbox__Username>
      <AlmOps__Sandbox__Token>xxx</AlmOps__Sandbox__Token>
      <AlmOps__Sandbox__Project>xxx</AlmOps__Sandbox__Project>
      <AlmOps__Sandbox__VariableGroupId>xxx</AlmOps__Sandbox__VariableGroupId>
      <AlmOps__Sandbox__GitLab__Token>glpat-xxxx</AlmOps__Sandbox__GitLab__Token>
      <AlmOps__Sandbox__GitLab__GroupId>xxx</AlmOps__Sandbox__GitLab__GroupId>
      <AlmOps__Sandbox__GitLab__ProjectId>xxx</AlmOps__Sandbox__GitLab__ProjectId>
    </EnvironmentVariables>
  </RunConfiguration>
</RunSettings>
  • Configure IDE to use this file for test configuration
    • Rider: File | Settings | Build, Execution, Deployment | Unit Testing | Test Runner, then in Test Settings (at the bottom)

Run from a NuGet package installation

# packs the projects
dotnet pack

# installs from local package
dotnet tool update -g almops --add-source=src/ConsoleApp/nupkg --version 1.3.0-alpha-000000

# adds .NET local tools to PATH
export PATH="$PATH:$HOME/.dotnet/tools"

# runs the tool
almops list projects

# uninstalls the tool
dotnet tool uninstall -g almops

Run in a container

docker build . -t devprofr/almops -f src/ConsoleApp/Dockerfile --no-cache
docker run -it --rm --name almops \
  -e almops__BaseUrl="https://dev.azure.com/xxx" -e almops__Username="xxx" -e almops__Token="xxx" \
  devprofr/almops list projects

References

Azure DevOps documentation

Tips

Rider shortcuts

Key combination Action
F4 Open project definition file
Ctrl+Enter Open context menu
Ctrl+Alt+Enter Format file