{"id":26531602,"url":"https://github.com/raven-actions/debug","last_synced_at":"2025-03-21T18:22:43.965Z","repository":{"id":158480408,"uuid":"633713113","full_name":"raven-actions/debug","owner":"raven-actions","description":"🩺 Dump GitHub contexts and Runner environment, and post action webhook payloads to the SMEE.io","archived":false,"fork":false,"pushed_at":"2024-07-12T20:35:51.000Z","size":251,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T08:47:21.564Z","etag":null,"topics":["actions","composite-action","context","debug","debugging","github","github-actions","github-context","github-runner","logging","raven-actions","runner","smee","utilities","workflows"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/debug-github-action","language":null,"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/raven-actions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-28T05:45:57.000Z","updated_at":"2024-07-12T20:35:52.000Z","dependencies_parsed_at":"2024-03-09T19:29:15.425Z","dependency_job_id":"20dc5398-ce3e-433c-b47e-1658eb35efe2","html_url":"https://github.com/raven-actions/debug","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raven-actions%2Fdebug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raven-actions%2Fdebug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raven-actions%2Fdebug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raven-actions%2Fdebug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raven-actions","download_url":"https://codeload.github.com/raven-actions/debug/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244845024,"owners_count":20519889,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["actions","composite-action","context","debug","debugging","github","github-actions","github-context","github-runner","logging","raven-actions","runner","smee","utilities","workflows"],"created_at":"2025-03-21T18:22:43.051Z","updated_at":"2025-03-21T18:22:43.950Z","avatar_url":"https://github.com/raven-actions.png","language":null,"readme":"# 🩺 Debug Action\n\n[![GitHub - marketplace](https://img.shields.io/badge/marketplace-debug--github--action-blue?logo=github\u0026style=flat-square)](https://github.com/marketplace/actions/debug-github-action)\n[![GitHub - release](https://img.shields.io/github/v/release/raven-actions/debug?style=flat-square)](https://github.com/raven-actions/debug/releases/latest)\n[![GitHub - ci](https://img.shields.io/github/actions/workflow/status/raven-actions/debug/ci.yml?logo=github\u0026label=CI\u0026style=flat-square\u0026branch=main\u0026event=push)](https://github.com/raven-actions/debug/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush)\n[![GitHub - license](https://img.shields.io/github/license/raven-actions/debug?style=flat-square)](https://github.com/raven-actions/debug/blob/main/LICENSE)\n\nThis [GitHub Action](https://github.com/features/actions) allows you to quickly and easily dump [GitHub contexts](https://docs.github.com/en/actions/learn-github-actions/contexts) and Runner environment and post action webhook payloads to the [SMEE.io](https://smee.io) service, giving you a comprehensive overview of the current state of your GitHub workflow. This can be useful for developing, troubleshooting, debugging GitHub workflows or actions, or understanding how different components interact.\n\n- Action is platform-independent and tested on all the latest GitHub-hosted runners (`ubuntu-latest`, `macos-latest`, `windows-latest`).\n- The output of each dump is in the `JSON` format as much as possible.\n\n![demo](https://raw.githubusercontent.com/raven-actions/debug/main/assets/images/demo.png)\n\n## Table of Contents \u003c!-- omit in toc --\u003e\n\n- [🤔 Usage](#-usage)\n  - [Quick Start](#quick-start)\n  - [Extra contexts](#extra-contexts)\n  - [Run only when `GitHub debug logging` enabled](#run-only-when-github-debug-logging-enabled)\n  - [SMEE.io](#smeeio)\n- [📥 Inputs](#-inputs)\n- [📤 Outputs](#-outputs)\n- [👥 Contributing](#-contributing)\n- [📄 License](#-license)\n\n## 🤔 Usage\n\n### Quick Start\n\nJust place in your GitHub workflow steps:\n\n```yaml\n- name: Debug\n  uses: raven-actions/debug@v1\n```\n\n### Extra contexts\n\nBy default, [composite](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) action cannot access contexts like `vars`, `secrets` `needs`, `inputs`. So if you want to include them in the dump, you must specify them explicitly. For more details, follow [📥 Inputs](#-inputs) section.\n\n\u003e ⚠️ `secrets` contexts will not show your secrets in the log! It's masked `***` by default.\n\n```yaml\n- name: Debug\n  uses: raven-actions/debug@v1\n  with:\n    vars-context: ${{ toJson(vars) }}  # optional\n    secrets-context: ${{ toJson(secrets) }}  # optional\n    needs-context: ${{ toJson(needs) }}  # optional\n    inputs-context: ${{ toJson(inputs) }}  # optional\n```\n\n### Run only when `GitHub debug logging` enabled\n\nIn certain circumstances (e.g., re-run failing workflow), if you'd like to run `Debug Action` only when [GitHub debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging) is enabled, then set `env` on workflow or job level:\n\n```yaml\nenv:\n  DEBUG: ${{ secrets.ACTIONS_RUNNER_DEBUG || vars.ACTIONS_RUNNER_DEBUG || secrets.ACTIONS_STEP_DEBUG || vars.ACTIONS_STEP_DEBUG || false }}\n```\n\nand add `if: ${{ env.DEBUG == 'true' }}` condition to the action.\n\n```yaml\n- name: Debug\n  if: ${{ env.DEBUG == 'true' }}\n  uses: raven-actions/debug@v1\n  with:\n    vars-context: ${{ toJson(vars) }}  # optional\n    secrets-context: ${{ toJson(secrets) }}  # optional\n    needs-context: ${{ toJson(needs) }}  # optional\n    inputs-context: ${{ toJson(inputs) }}  # optional\n```\n\n### SMEE.io\n\n\u003e ⚠️ This feature is intended for debugging purposes only and should not be used to handle **sensitive data**. Additionally, please be aware that any authentication does not secure SMEE.io, and anyone with the channel ID can access your payloads.\n\nAid in debugging GitHub Action runs by expertly posting webhook payloads to [SMEE.io](https://smee.io).\n\nTo access the channel, please make sure you have a browser tab open to the channel URL.\n\n```yaml\n- name: Debug\n  id: debug\n  uses: raven-actions/debug@v1\n  with:\n    smee: true  # optional, if not set then default is `false`\n    smee-channel: my-custom-channel-name # optional, if not set then default is `repositoryOwner-repositoryName`, e.g. raven-actions-debug\n\n- name: Debug outputs\n  if: ${{ steps.debug.outputs.smee == 'true' }}  # example usage\n  run: |\n    echo \"Your SMEE.io URL is: ${{ steps.debug.outputs.smee-url }}\"\n```\n\n## 📥 Inputs\n\n|       Name        | Required |     Type      | Default value | Description                                                                                               |\n|:-----------------:|:--------:|:-------------:|:-------------:|-----------------------------------------------------------------------------------------------------------|\n|  `vars-context`   |  false   | `json object` |   *not set*   | The context for the `vars` must be explicitly provided, as it is unavailable in the composite actions.    |\n| `secrets-context` |  false   | `json object` |   *not set*   | The context for the `secrets` must be explicitly provided, as it is unavailable in the composite actions. |\n|  `needs-context`  |  false   | `json object` |   *not set*   | The context for the `needs` must be explicitly provided, as it is unavailable in the composite actions.   |\n| `inputs-context`  |  false   | `json object` |   *not set*   | The context for the `inputs` must be explicitly provided, as it is unavailable in the composite actions.  |\n|      `smee`       |  false   |    `bool`     |    `false`    | Aid in debugging GitHub Action runs by expertly posting webhook payloads to SMEE.io.                      |\n|  `smee-channel`   |  false   |   `string`    |   *not set*   | If the SMEE channel ID is not provided, the ID of the repository will be utilized instead.                |\n\n## 📤 Outputs\n\n|    Name    |   Type   | Description                                                 |\n|:----------:|:--------:|-------------------------------------------------------------|\n| `smee-url` | `string` | The SMEE URL to use. If SMEE is not used, it will be empty. |\n\n## 👥 Contributing\n\nContributions to the project are welcome! Please follow [Contributing Guide](https://github.com/raven-actions/debug/blob/main/.github/CONTRIBUTING.md).\n\n## 📄 License\n\nThis project is distributed under the terms of the [MIT](https://github.com/raven-actions/debug/blob/main/LICENSE) license.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraven-actions%2Fdebug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraven-actions%2Fdebug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraven-actions%2Fdebug/lists"}