microsoft/action-publish-symbols

GitHub Action to publish symbols to the Azure DevOps Package Management symbol server (Artifacts server).

Publish Symbols Action

Use this Action to publish symbols to the Azure DevOps Package Management symbol server (Artifacts server). Symbol servers enables your debugger to automatically retrieve the correct symbol files without knowing product names, build numbers or package names.

Usage

See action.yml

Example Usage from a repository containing .NET Core code:

 steps:
    - uses: actions/checkout@v3
    - name: Setup .NET Core
      uses: actions/setup-dotnet@v2
      with:
        dotnet-version: 5.0.102
    - name: Install dependencies
      working-directory: './src'
      run: dotnet restore
    - name: Build
      working-directory: './src'
      run: dotnet build --configuration Debug --no-restore
    - uses: microsoft/[email protected]
      with:
        accountName: <Azure DevOps Account Name>
        symbolServiceUrl: 'https://artifacts.dev.azure.com'
        personalAccessToken: ${{ secrets.PERSONALACCESSTOKEN }}

The account name should be the Azure DevOps Organization name.

The scope of the PAT ( Personal Access Token) generated from Azure DevOps to authenticate the request to Artifacts server should be of the include scopes:

• Symbols - Read, Write & Manage
• Build - Read, Write & Manage

Sample usage in a .Net Core Project: https://github.com/tanmayghosh2507/GitHubPublicActiontest

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

action-publish-symbols's Issues

action-publish-symbols requires a dependency update

GitHub is deprecating Node 12 and is recommending an update to at least Node 16: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

The current released version 2.1.6 has a Node 12 dependency and needs to be updated for this deprecation.

Request failed with status code 404

Hello, I'm trying to migrate from an internal VSO repo to GitHub (currently private), and trying to get symbol server publishing from a GitHub action working. I am currently getting a 404 error code though.

Example internal pipeline run that works: https://mscodehub.visualstudio.com/WindowsXDP/_build/results?buildId=265387&view=logs&j=dd755d80-e2a8-5bc6-1364-e03f69bfc23b&t=79e9e941-3473-58ec-d89d-2e6a82029a75
Example external Action that is failing: https://github.com/microsoft/xdp-for-windows/runs/6442213846?check_suite_focus=true#step:10:9

My usage:

    - uses: microsoft/action-publish-symbols@v1
      with:
        accountName: nibanks
        symbolServiceUrl: 'https://mscodehub.artifacts.visualstudio.com'
        personalAccessToken: ${{ secrets.AZDO_PAT }}

Action output:

Run microsoft/action-publish-symbols@v1
Symbol Request Name = microsoft/xdp-for-windows/ci/10/2327846101/1ba201b2-520b-4e7d-fde1-b54928bb438c
Found 29 files
Error: Action failed with error Error: Request failed with status code 404

What am I doing wrong? Any help would be greatly appreciated.

cc @thhous-msft

Just Started Getting: Action failed with error Error: versionSpec parameter is required

I just merged a PR into microsoft/xdp-for-windows and our GH Action is failing with:

Action failed with error Error: versionSpec parameter is required

https://github.com/microsoft/xdp-for-windows/runs/7263931145?check_suite_focus=true.

cc @mtfriesen

Doesn't work on a self-hosted runners behind a proxy server

Related to #4

Doesn't work on ubuntu agents

Related to #4

personal access token with Symbols Read/Write doesn't work

If I use a personal access token with Symbols Read/Write, I will meet an error of 401.
If I use a personal access token with full access, the action just works successfully. But I couldn't find the SourceMap files in my Azure Devops Artifacts. Maybe I misunderstood something, please give a guidance.

Action failed with error Error: read ECONNRESET

Trying to publish symbols of a .net core project using this action but it fails pretty quickly with this error:

Symbol Request Name = xxx
Found 25 files
Error: Action failed with error Error: read ECONNRESET

Any idea what could possibly be the issue?