{"id":25836004,"url":"https://github.com/bugsplat-git/github-action-example","last_synced_at":"2026-06-10T19:31:40.135Z","repository":{"id":264896437,"uuid":"803776359","full_name":"BugSplat-Git/github-action-example","owner":"BugSplat-Git","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-21T13:28:02.000Z","size":18661,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-03-30T07:31:32.154Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BugSplat-Git.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-21T11:16:07.000Z","updated_at":"2024-05-21T15:48:04.000Z","dependencies_parsed_at":"2024-11-26T18:02:18.039Z","dependency_job_id":null,"html_url":"https://github.com/BugSplat-Git/github-action-example","commit_stats":null,"previous_names":["bugsplat-git/github-action-example"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/BugSplat-Git/github-action-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fgithub-action-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fgithub-action-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fgithub-action-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fgithub-action-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BugSplat-Git","download_url":"https://codeload.github.com/BugSplat-Git/github-action-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fgithub-action-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34168086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-01T01:38:49.518Z","updated_at":"2026-06-10T19:31:40.114Z","avatar_url":"https://github.com/BugSplat-Git.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)](https://bugsplat.com)\r\n\u003cbr/\u003e\r\n# \u003cdiv align=\"center\"\u003eBugSplat\u003c/div\u003e \r\n### **\u003cdiv align=\"center\"\u003eCrash and error reporting built for busy developers.\u003c/div\u003e**\r\n\u003cdiv align=\"center\"\u003e\r\n    \u003ca href=\"https://twitter.com/BugSplatCo\"\u003e\r\n        \u003cimg alt=\"Follow @bugsplatco on Twitter\" src=\"https://img.shields.io/twitter/follow/bugsplatco?label=Follow%20BugSplat\u0026style=social\"\u003e\r\n    \u003c/a\u003e\r\n    \u003ca href=\"https://discord.gg/K4KjjRV5ve\"\u003e\r\n        \u003cimg alt=\"Join BugSplat on Discord\" src=\"https://img.shields.io/discord/664965194799251487?label=Join%20Discord\u0026logo=Discord\u0026style=social\"\u003e\r\n    \u003c/a\u003e\r\n\u003c/div\u003e\r\n\r\n# github-action-example\r\n\r\nThis repo contains an example GitHub Action that builds a Windows C++ application and uses [symbol-upload](https://github.com/BugSplat-Git/symbol-upload) to publish symbols to BugSplat. You can either use this template repo, or follow the steps below to configure an existing application.\r\n\r\n## Steps 🥾\r\n\r\n1. Create a new [BugSplat](https://www.bugsplat.com) database\r\n2. Generate an OAuth2 Client ID and Client Secret pair on the [Integrations](https://app.bugsplat.com/v2/database/integrations#oauth) page\r\n3. Create a [repository secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) in your GitHub repo with the key `BUGSPLAT_DATABASE` and your BugSplat database name as the value\r\n4. Create repository secrets for `SYMBOL_UPLOAD_CLIENT_ID` and `SYMBOL_UPLOAD_CLIENT_SECRET`\r\n5. Configure BugSplat according to the [docs for your specific platform](https://docs.bugsplat.com/introduction/getting-started/integrations).\r\n6. If you're using preprocessor definitions to supply a value for `BUGSPLAT_DATABASE`, be sure to configure your project file as seen [here](https://github.com/BugSplat-Git/github-action-example/blob/cd3d15eda4ed715bbe931490d32e074628dcd036/Samples/myConsoleCrasher/myConsoleCrasher.vcxproj#L169-L170).\r\n7. Create a GitHub Action that builds your project an uploads symbols. Here's a copy of the action used by this repo\r\n\r\n```yml\r\nname: Build myConsoleCrasher Project\r\n\r\non: [push]\r\n\r\njobs:\r\n  build:\r\n    name: Build myConsoleCrasher\r\n    runs-on: windows-latest\r\n\r\n    steps:\r\n    - name: Checkout code\r\n      uses: actions/checkout@v3\r\n\r\n    - name: Setup MSBuild path\r\n      uses: microsoft/setup-msbuild@v1.1\r\n\r\n    - name: Build myConsoleCrasher project\r\n      env:\r\n        BUGSPLAT_DATABASE: ${{ secrets.BUGSPLAT_DATABASE }}\r\n      run: msbuild .\\Samples\\myConsoleCrasher\\myConsoleCrasher.vcxproj /p:configuration=release /p:DefineConstants=BUGSPLAT_DATABASE=%BUGSPLAT_DATABASE%\r\n\r\n    - name: Symbols 📦\r\n      uses: BugSplat-Git/symbol-upload@main\r\n      with:\r\n        clientId: \"${{ secrets.SYMBOL_UPLOAD_CLIENT_ID }}\"\r\n        clientSecret: \"${{ secrets.SYMBOL_UPLOAD_CLIENT_SECRET }}\"\r\n        database: \"${{ secrets.BUGSPLAT_DATABASE }}\"\r\n        application: \"MyConsoleCrasher\"\r\n        version: \"1.0.0\"\r\n        files: \"*.{pdb,exe,dll}\"\r\n        directory: \"BugSplat\\\\Win32\\\\release\"\r\n        node-version: \"20\"\r\n```\r\n\r\n8. Trigger a build and navigate to BugSplat's [Versions](https://app.bugsplat.com/v2/versions) page to verify symbols were uploaded.\r\n9. Run your application and generate a crash report to test your BugSplat integration.\r\n\r\n\u003cimg width=\"1725\" alt=\"image\" src=\"https://github.com/BugSplat-Git/github-action-example/assets/2646053/92c052d0-574a-4556-8cf7-1bc1b228a2f3\"\u003e\r\n\r\n## 👷 Support\r\n\r\nIf you have any additional questions, please email our [support](mailto:support@bugsplat.com) team, join us on [Discord](https://discord.gg/bugsplat), or reach out via the chat in our web application.\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugsplat-git%2Fgithub-action-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbugsplat-git%2Fgithub-action-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugsplat-git%2Fgithub-action-example/lists"}