{"id":28936511,"url":"https://github.com/frain-dev/mintlify-preview-action","last_synced_at":"2026-01-20T16:28:18.750Z","repository":{"id":278264440,"uuid":"934828635","full_name":"frain-dev/mintlify-preview-action","owner":"frain-dev","description":"Github action for Mintlify previewer.","archived":false,"fork":false,"pushed_at":"2025-03-03T22:42:59.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-11T15:02:35.156Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frain-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-02-18T13:23:23.000Z","updated_at":"2025-03-03T22:43:02.000Z","dependencies_parsed_at":"2025-02-18T21:45:47.924Z","dependency_job_id":null,"html_url":"https://github.com/frain-dev/mintlify-preview-action","commit_stats":null,"previous_names":["frain-dev/mintlify-preview-action"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/frain-dev/mintlify-preview-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frain-dev%2Fmintlify-preview-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frain-dev%2Fmintlify-preview-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frain-dev%2Fmintlify-preview-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frain-dev%2Fmintlify-preview-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frain-dev","download_url":"https://codeload.github.com/frain-dev/mintlify-preview-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frain-dev%2Fmintlify-preview-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28607110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-06-22T20:41:27.843Z","updated_at":"2026-01-20T16:28:18.745Z","avatar_url":"https://github.com/frain-dev.png","language":null,"readme":"# Mintlify Preview GitHub Action 🚀\n\nThis GitHub Action automates the process of deploying a **Mintlify preview** for documentation updates when a pull\nrequest is opened or updated. It posts a comment on the pull request with a link to the preview deployment.\n\n## Usage\n\nTo use this action, add the following workflow to your repository (`.github/workflows/mintlify-preview.yml`):\n\n```yaml\nname: Mintlify Preview\n\non:\n  pull_request:\n    paths:\n      - 'docs/**'  # Trigger only for changes in the docs directory\n    types:\n      - opened\n      - synchronize\n\njobs:\n  preview:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout repository\n        uses: actions/checkout@v4\n\n      - name: Deploy Mintlify Preview\n        uses: frain-dev/mintlify-preview-action@v0.1.3\n        with:\n          docs_path: \"docs/mint.json\"  # Path to your documentation file\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Inputs\n\nThe action accepts the following inputs:\n\n| Input Name     | Description                                             | Required | Default Value                                    |\n|----------------|---------------------------------------------------------|----------|--------------------------------------------------|\n| `docs_path`    | Path to the documentation file (e.g., `docs/mint.json`) | Yes      | None                                             |\n| `backend_url`  | Custom backend server for deployment (optional)         | No       | `https://mintlify-previewer.getconvoy.io/deploy` |\n| `github_token` | GitHub token to comment on the PR                       | Yes      | None                                             |\n\n## Outputs\n\nThe action provides the following output:\n\n| Output Name      | Description                     |\n|------------------|---------------------------------|\n| `deployment_url` | The URL of the Mintlify preview |\n\n## Branding\n\n- **Icon**: `upload-cloud`\n- **Color**: `blue`\n\n## How It Works\n\n1. The action triggers on pull requests that modify files in the `docs/` directory.\n2. It sends a request to the Mintlify previewer backend with the pull request details and documentation path.\n3. The backend generates a preview deployment and returns the deployment URL.\n4. The action posts a comment on the pull request with the preview URL.\n\n## Example\n\nHere’s an example of the comment posted on the pull request:\n\n```\n🚀 Mintlify preview available at: https://01jnewdvfews9e74yvxftbp67c.mintlify-previewer.getconvoy.io\n\nPowered by Convoy - send webhooks in minutes not months!\n```\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n---\n\nMade with ❤️ by [frain-dev](https://github.com/frain-dev)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrain-dev%2Fmintlify-preview-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrain-dev%2Fmintlify-preview-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrain-dev%2Fmintlify-preview-action/lists"}