{"id":25543467,"url":"https://github.com/imposter-project/imposter-github-action","last_synced_at":"2026-05-17T17:43:43.846Z","repository":{"id":275662694,"uuid":"926794743","full_name":"imposter-project/imposter-github-action","owner":"imposter-project","description":"Official GitHub Actions for Imposter, a modern mock server designed for microservice development and testing.","archived":false,"fork":false,"pushed_at":"2025-02-04T13:55:33.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-23T06:17:15.548Z","etag":null,"topics":["github-actions","imposter","mock","mock-server"],"latest_commit_sha":null,"homepage":"https://www.imposter.sh","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/imposter-project.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null}},"created_at":"2025-02-03T21:41:05.000Z","updated_at":"2025-02-04T13:55:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"cf409e6b-ab58-447c-b262-955446896ab0","html_url":"https://github.com/imposter-project/imposter-github-action","commit_stats":null,"previous_names":["imposter-project/imposter-github-action"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/imposter-project/imposter-github-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imposter-project%2Fimposter-github-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imposter-project%2Fimposter-github-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imposter-project%2Fimposter-github-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imposter-project%2Fimposter-github-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imposter-project","download_url":"https://codeload.github.com/imposter-project/imposter-github-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imposter-project%2Fimposter-github-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266626115,"owners_count":23958344,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["github-actions","imposter","mock","mock-server"],"created_at":"2025-02-20T07:19:32.903Z","updated_at":"2026-05-17T17:43:38.824Z","avatar_url":"https://github.com/imposter-project.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Imposter GitHub Actions [![CI/CD](https://github.com/imposter-project/imposter-github-action/actions/workflows/ci.yml/badge.svg)](https://github.com/imposter-project/imposter-github-action/actions/workflows/ci.yml)\n\nThis repository contains official GitHub Actions for [Imposter](https://www.imposter.sh), a modern mock server designed for microservice development and testing. These actions allow you to seamlessly integrate Imposter into your GitHub Actions workflows.\n\n\u003e [!NOTE]\n\u003e Replace `v1` in the examples below with the [latest release](https://github.com/imposter-project/imposter-github-action/releases).\n\n## Available Actions\n\n### 1. Setup Imposter (`setup`)\nDownloads and installs the Imposter mock server.\n\n```yaml\n- uses: imposter-project/imposter-github-action/setup@v1\n```\n\n### 2. Start Mocks (`start-mocks`)\nStarts the Imposter mock server in the background, and waits for it to be ready.\n\n```yaml\n- uses: imposter-project/imposter-github-action/start-mocks@v1\n  with:\n    # Optional: Path to the directory containing the Imposter configuration files\n    config-dir: './mocks'      # default: './mocks'\n    # Optional: Port number for the Imposter server\n    port: '8080'               # default: '8080'\n    # Optional: Version of the Imposter mock engine to use\n    version: '1.2.3'           # default: '' (latest)\n    # Optional: Type of mock engine to use (jvm or docker)\n    engine-type: 'docker'      # default: 'docker'\n    # Optional: Whether to recursively scan the config directory\n    recursive-config-scan: 'false'  # default: 'false'\n```\n\n\u003e [!NOTE]\n\u003e For `version`, choose from the Imposter [releases](https://github.com/outofcoffee/imposter/releases) page.\n\n\u003cdetails\u003e\n\u003csummary\u003eAdvanced configuration options\u003c/summary\u003e\n\n- `auto-restart`: Whether to automatically restart when configuration changes (default: false)\n- `max-attempts`: Maximum number of attempts to check if the server is ready (default: 30)\n- `retry-interval`: Interval in seconds between retry attempts (default: 1)\n\n\u003c/details\u003e\n\n#### Outputs\n- `base-url`: Base URL of the mock server (e.g. `http://localhost:8080`)\n\n### 3. Stop Mocks (`stop-mocks`)\nStops the running Imposter mock server.\n\n```yaml\n- uses: imposter-project/imposter-github-action/stop-mocks@v1\n  with:\n    # Optional: Type of mock engine to use (jvm or docker)\n    engine-type: 'docker'      # default: 'docker'\n```\n\n## Sample Workflow\n\nHere's a complete example showing how to use all three actions in a workflow:\n\n```yaml\nname: Integration Tests with Mocks\n\non:\n  push:\n    branches: [ main ]\n  pull_request:\n    branches: [ main ]\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n    \n    steps:\n    - uses: actions/checkout@v4\n    \n    # Install Imposter CLI\n    - name: Setup Imposter\n      uses: imposter-project/imposter-github-action/setup@v1\n    \n    # Start mock server\n    - name: Start Mocks\n      id: start-mocks\n      uses: imposter-project/imposter-github-action/start-mocks@v1\n      with:\n        config-dir: './mocks'\n        port: '8080'            # Optional: specify port number\n        engine-type: 'docker'   # Optional: specify engine type\n        version: '1.2.3'        # Optional: specify engine version\n        recursive-config-scan: 'true'  # Optional: scan config directory recursively\n    \n    # Your test steps here\n    - name: Run Tests\n      run: |\n        # The mock server is available at ${{ steps.start-mocks.outputs.base-url }}\n        echo \"Running tests against mock server at ${{ steps.start-mocks.outputs.base-url }}\"\n    \n    # Stop mock server\n    - name: Stop Mocks\n      uses: imposter-project/imposter-github-action/stop-mocks@v1\n      with:\n        engine-type: 'docker'   # Should match the engine-type used in start-mocks\n```\n\n## Configuration\n\nThe mock server configuration should be placed in your repository according to the `config-dir` parameter (defaults to `./mocks`). For detailed information about configuring Imposter mocks, please visit the [official documentation](https://docs.imposter.sh/configuration/).\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Links\n\n- [Imposter Official Website](https://www.imposter.sh)\n- [Imposter Documentation](https://docs.imposter.sh)\n- [GitHub Repository](https://github.com/imposter-project/imposter-github-action)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimposter-project%2Fimposter-github-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimposter-project%2Fimposter-github-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimposter-project%2Fimposter-github-action/lists"}