Skip to content

Create YAML workflow snippets for Dev Proxy Actions (@dev-proxy-tools/actions) #301

@garrytrinder

Description

@garrytrinder

Create reusable YAML workflow snippets for each Dev Proxy Action listed in the @dev-proxy-tools/actions README.md, including install, start, stop, record-start, and record-stop. Each snippet should:

  • Be a valid YAML block for a workflow step using the appropriate Dev Proxy Action.
  • Demonstrate required and optional inputs where applicable.
  • Include inline comments and placeholders for user customization.
  • Follow the VS Code snippet object format for snippets.json, as in @garrytrinder/dev-proxy-toolkit/src/snippets.json.
  • Use a fixed @v1 for all action versions.

Specification with Example Snippets:


{ "DevProxyActionInstall": { "prefix": "devproxy-action-install", "body": [ "- name: Install Dev Proxy", " uses: dev-proxy-tools/actions/install@v1", " with:", " version: ${1:latest} # Optionally specify the version, e.g. v0.29.2" ], "description": "GitHub Actions step: Install Dev Proxy" }, "DevProxyActionStart": { "prefix": "devproxy-action-start", "body": [ "- name: Start Dev Proxy", " uses: dev-proxy-tools/actions/start@v1", " with:", " log-file: ${1:devproxy.log} # Optional: specify the log file name", " config-file: ${2:./devproxyrc.json} # Optional: specify your Dev Proxy config file", " auto-stop: ${3:true} # Optional: set to false if you don't want auto-stop" ], "description": "GitHub Actions step: Start Dev Proxy" }, "DevProxyActionStop": { "prefix": "devproxy-action-stop", "body": [ "- name: Stop Dev Proxy", " uses: dev-proxy-tools/actions/stop@v1" ], "description": "GitHub Actions step: Stop Dev Proxy" }, "DevProxyActionRecordStart": { "prefix": "devproxy-action-record-start", "body": [ "- name: Start recording", " uses: dev-proxy-tools/actions/record-start@v1" ], "description": "GitHub Actions step: Start Dev Proxy recording" }, "DevProxyActionRecordStop": { "prefix": "devproxy-action-record-stop", "body": [ "- name: Stop recording", " uses: dev-proxy-tools/actions/record-stop@v1" ], "description": "GitHub Actions step: Stop Dev Proxy recording" } }

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions