Exercise - Reference the package from the application


In this unit, you'll get the new Tailspin.SpaceGame.Web code that has the model classes removed. Instead of referencing the models directly, the code will reference them from the package you created in the previous unit.

Here's a list of the steps:

  • Get the new code from a branch of the original Tailspin.SpaceGame.Web repository.
  • Reference the new Models package, version 1.0.0.
  • To look for this package in your Azure Artifacts feed, change the build pipeline.
  • Watch the pipeline successfully build the app.

Fetch the branch from GitHub

Fetch the models-package branch from GitHub and check out, or switch to, that branch.

This branch contains the Space Game project you worked with in the previous modules, but the Models directory has been removed.

  1. Switch to your copy of Visual Studio Code that shows the Tailspin.SpaceGame.Web project.

  2. From the terminal, to fetch a branch named models-package from the Microsoft repository, run the following git commands. Then, switch to that branch.

    git fetch upstream models-package
    git checkout -B models-package upstream/models-package

    The format of these commands enables you to get starter code from the Microsoft repository on GitHub, known as upstream. Shortly, you'll push this branch up to your GitHub repository, known as origin.

  3. As an optional step, verify that the Models directory no longer exists in the file explorer.

    Instead, you see Controllers, Views, and other directories.

Reference the Models package

  1. Open the Tailspin.SpaceGame.Web.csproj file and add the following ItemGroup:

      <PackageReference Include="Tailspin.SpaceGame.Web.Models" Version="1.0.0" />

    Be sure to place the ItemGroup inside the Project node. Your file should resemble this:

    <Project Sdk="Microsoft.NET.Sdk.Web">
        <PackageReference Include="Tailspin.SpaceGame.Web.Models" Version="1.0.0" />
        <Folder Include="wwwroot\images\avatars\" />
  2. Modify the version, "1.0.0", to include the pre-release prefix that was generated during the build process. Here's an example:

    <PackageReference Include="Tailspin.SpaceGame.Web.Models" Version="1.0.0-CI-20200610-165738" />

    This references the Tailspin.SpaceGame.Web.Models package that you created in Azure Artifacts. Notice the version number, 1.0.0, plus the pre-release suffix. This matches the initial version that you published to Azure Artifacts in the previous unit.

  3. Save the file.


    When you save the file, Visual Studio Code might ask you to restore dependencies. Select the Restore button to restore the dependencies.

Modify the pipeline configuration

The models-package branch provides an initial azure-pipelines.yml file. Here, you modify the pipeline configuration to pull the Tailspin.SpaceGame.Web.Models package from Azure Artifacts.

  1. From Visual Studio Code, open azure-pipelines.yml.

  2. Modify azure-pipelines.yml as shown here:

    - '*'
      vmImage: 'ubuntu-20.04'
      - npm
      buildConfiguration: 'Release'
      wwwrootDir: 'Tailspin.SpaceGame.Web/wwwroot'
      dotnetSdkVersion: '6.x'
    - task: UseDotNet@2
      displayName: 'Use .NET SDK $(dotnetSdkVersion)'
        version: '$(dotnetSdkVersion)'
    - task: NuGetToolInstaller@0
        versionSpec: '5.9.1'
    - task: Npm@1
      displayName: 'Run npm install'
        verbose: false
    - script: './node_modules/.bin/node-sass $(wwwrootDir) --output $(wwwrootDir)'
      displayName: 'Compile Sass assets'
    - task: gulp@1
      displayName: 'Run gulp tasks'
    - script: 'echo "$(Build.DefinitionName), $(Build.BuildId), $(Build.BuildNumber)" > buildinfo.txt'
      displayName: 'Write build info'
      workingDirectory: $(wwwrootDir)
    - task: NuGetCommand@2
      displayName: 'Restore project dependencies'
        command: 'restore'
        restoreSolution: '**/*.sln'
        feedsToUse: 'select'
        vstsFeed: '$(System.TeamProject)/Tailspin.SpaceGame.Web.Models'
    - task: DotNetCoreCLI@2
      displayName: 'Build the project - $(buildConfiguration)'
        command: 'build'
        arguments: '--no-restore --configuration $(buildConfiguration)'
        projects: '**/*.csproj'
    - task: DotNetCoreCLI@2
      displayName: 'Publish the project - $(buildConfiguration)'
        command: 'publish'
        projects: '**/*.csproj'
        publishWebProjects: false
        arguments: '--no-build --configuration $(buildConfiguration) --output $(Build.ArtifactStagingDirectory)/$(buildConfiguration)'
        zipAfterPublish: true
    - task: PublishBuildArtifacts@1
      displayName: 'Publish Artifact: drop'
      condition: succeeded()

    The highlighted code shows where the pipeline restores dependencies, and looks in your Azure Artifacts feed for the dependencies that might be there.

  3. Stage, commit, and push your changes to GitHub.

    git add .
    git commit -m "Add reference to Models package"
    git push origin models-package
  4. Go to Azure Pipelines and watch the build run. The build picks up your Models package from Azure Artifacts and builds the project successfully.