{"id":13533658,"url":"https://github.com/nwtgck/actions-netlify","last_synced_at":"2025-05-15T03:06:26.121Z","repository":{"id":36998662,"uuid":"238209201","full_name":"nwtgck/actions-netlify","owner":"nwtgck","description":"🚀 Netlify deploy from GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-09-15T19:04:39.000Z","size":43958,"stargazers_count":343,"open_issues_count":38,"forks_count":44,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-05-12T22:38:47.616Z","etag":null,"topics":["actions","deployment","github-actions","netlify","static-site"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/nwtgck.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}},"created_at":"2020-02-04T13:11:16.000Z","updated_at":"2025-05-11T19:17:14.000Z","dependencies_parsed_at":"2024-04-25T20:25:20.554Z","dependency_job_id":"9219e5d7-a7f9-4f2d-8f1d-fe730678bce8","html_url":"https://github.com/nwtgck/actions-netlify","commit_stats":{"total_commits":378,"total_committers":27,"mean_commits":14.0,"dds":0.4894179894179894,"last_synced_commit":"f242d4c9f946f94d2ed8413888eaf35e1f7e848d"},"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Factions-netlify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Factions-netlify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Factions-netlify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Factions-netlify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nwtgck","download_url":"https://codeload.github.com/nwtgck/actions-netlify/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254040172,"owners_count":22004461,"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","deployment","github-actions","netlify","static-site"],"created_at":"2024-08-01T07:01:21.879Z","updated_at":"2025-05-15T03:06:21.102Z","avatar_url":"https://github.com/nwtgck.png","language":"TypeScript","funding_links":[],"categories":["Community Resources","TypeScript"],"sub_categories":["Deployment"],"readme":"# actions-netlify\n![build-test](https://github.com/nwtgck/actions-netlify/workflows/build-test/badge.svg)\n\nGitHub Actions for deploying to Netlify\n\n\u003cimg src=\"doc_assets/deploy-url-comment.png\" width=\"650\"\u003e\n\nDeploy URLs are commented on your pull requests and commit comments!\n\n\u003cimg src=\"doc_assets/github-deployment.png\" width=\"650\"\u003e\n\nGitHub Deployments are also supported!\n\n## Usage\n\n```yaml\n# .github/workflows/netlify.yml\nname: Build and Deploy to Netlify\non:\n  push:\n  pull_request:\njobs:\n  build:\n    runs-on: ubuntu-22.04\n    steps:\n      - uses: actions/checkout@v4\n\n      # ( Build to ./dist or other directory... )\n\n      - name: Deploy to Netlify\n        uses: nwtgck/actions-netlify@v3.0\n        with:\n          publish-dir: './dist'\n          production-branch: master\n          github-token: ${{ secrets.GITHUB_TOKEN }}\n          deploy-message: \"Deploy from GitHub Actions\"\n          enable-pull-request-comment: false\n          enable-commit-comment: true\n          overwrites-pull-request-comment: true\n        env:\n          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}\n          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}\n        timeout-minutes: 1\n```\n\n\n### Required inputs and env\n- `publish-dir` (e.g. \"dist\", \"_site\")\n- `NETLIFY_AUTH_TOKEN`: [Personal access tokens](https://app.netlify.com/user/applications#personal-access-tokens) \u003e New access token\n- `NETLIFY_SITE_ID`: team page \u003e your site \u003e Settings \u003e Site details \u003e Site information \u003e API ID\n  - NOTE: API ID is `NETLIFY_SITE_ID`.\n\n### Optional inputs\n- `production-branch` (e.g. \"master\")\n- `production-deploy`: Deploy as Netlify production deploy (default: false)\n- `github-token: ${{ secrets.GITHUB_TOKEN }}`\n- `deploy-message` A custom deploy message to see on Netlify deployment (e.g. `${{ github.event.pull_request.title }}`)\n- `enable-pull-request-comment: true` Comment on pull request (default: true)\n- `enable-commit-comment: true` Comment on GitHub commit (default: true)\n- `enable-commit-status: true` GitHub commit status (default: true)\n- `overwrites-pull-request-comment: true` Overwrites comment on pull request (default: true)\n- `netlify-config-path: ./netlify.toml` Path to `netlify.toml` (default: undefined)\n- `functions-dir` Netlify functions output directory (default: undefined)\n- `alias` Specifies the prefix for the deployment URL, must not have uppercase or special characters (default: Netlify build ID)\n  - `alias: ${{ github.head_ref }}` replicates the [branch deploy prefix](https://docs.netlify.com/site-deploys/overview/#definitions)\n  - `alias: deploy-preview-${{ github.event.number }}` replicates the [deploy preview prefix](https://docs.netlify.com/site-deploys/overview/#definitions)\n- `enable-github-deployment` Whether or not to deploy to GitHub (default: true)\n- `github-deployment-environment` Environment name of GitHub Deployments\n- `github-deployment-description` Description of the GitHub Deployment\n- `fails-without-credentials` Fails if no credentials provided (default: false)\n\n### Paths are relative to the project's root\nAll paths (eg, `publish-dir`, `netlify-config-path`, `functions-dir`) are relative to the project's root or absolute paths.\n\n### Outputs\n- `deploy-url` A deployment URL generated by Netlify\n\n## Build on local\n\n```bash\nnpm ci\nnpm run all\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwtgck%2Factions-netlify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnwtgck%2Factions-netlify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwtgck%2Factions-netlify/lists"}