{"id":26364949,"url":"https://github.com/kaalpanikh/gh-deployment-workflow","last_synced_at":"2025-10-18T22:18:19.951Z","repository":{"id":275696295,"uuid":"926886676","full_name":"kaalpanikh/gh-deployment-workflow","owner":"kaalpanikh","description":"GitHub Actions workflow for deploying a static site to GitHub Pages seamlessly.","archived":false,"fork":false,"pushed_at":"2025-03-14T11:54:27.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T12:33:18.294Z","etag":null,"topics":["deployment","github-actions","github-pages","static-site","workflow"],"latest_commit_sha":null,"homepage":"https://pages.nikhilmishra.live","language":"HTML","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/kaalpanikh.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-04T02:56:58.000Z","updated_at":"2025-03-14T11:54:31.000Z","dependencies_parsed_at":"2025-02-04T04:39:17.324Z","dependency_job_id":null,"html_url":"https://github.com/kaalpanikh/gh-deployment-workflow","commit_stats":null,"previous_names":["kaalpanikh/gh-deployment-workflow"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaalpanikh%2Fgh-deployment-workflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaalpanikh%2Fgh-deployment-workflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaalpanikh%2Fgh-deployment-workflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaalpanikh%2Fgh-deployment-workflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaalpanikh","download_url":"https://codeload.github.com/kaalpanikh/gh-deployment-workflow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243919314,"owners_count":20368866,"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":["deployment","github-actions","github-pages","static-site","workflow"],"created_at":"2025-03-16T19:28:47.258Z","updated_at":"2025-10-18T22:18:14.921Z","avatar_url":"https://github.com/kaalpanikh.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Actions Deployment Workflow\n\nThis repository demonstrates a modern GitHub Actions workflow for deploying a static website to GitHub Pages. The project is based on the roadmap provided by [roadmap.sh](https://roadmap.sh/projects/github-actions-deployment-workflow) and showcases best practices for GitHub Actions deployment using the latest official GitHub Pages actions.\n\n## Features\n\n- **Modern GitHub Actions**: Uses the latest official GitHub Actions for Pages deployment\n- **Secure Deployment**: Implements secure deployment practices with proper permissions\n- **Continuous Deployment**: Automatically deploys changes pushed to the `main` branch\n- **Zero Configuration**: No additional setup required beyond enabling GitHub Pages\n\n## Project Structure\n\n```\n.\n├── .github\n│   └── workflows\n│       └── deploy.yml    # GitHub Actions workflow configuration\n├── index.html           # Static website with modern styling\n└── README.md           # Documentation\n```\n\n## Workflow Details\n\nThe deployment workflow (`.github/workflows/deploy.yml`) uses the following official GitHub Actions:\n\n- `actions/checkout@v4`: Checks out your repository\n- `actions/configure-pages@v4`: Sets up GitHub Pages\n- `actions/upload-pages-artifact@v3`: Packages your site\n- `actions/deploy-pages@v4`: Deploys to GitHub Pages\n\n### Key Features:\n\n- **Proper Permissions**: Explicitly defined permissions for security\n- **Environment Configuration**: Uses the github-pages environment\n- **Artifact Handling**: Efficient artifact upload and deployment\n- **Clean Workflow**: Minimal, maintainable configuration\n\n## Setup Instructions\n\n1. **Clone the Repository**\n   ```bash\n   git clone https://github.com/\u003cyour-username\u003e/gh-deployment-workflow.git\n   cd gh-deployment-workflow\n   ```\n\n2. **Enable GitHub Pages**\n   - Go to your repository's Settings \u003e Pages\n   - Under \"Build and deployment\", select \"GitHub Actions\" as the source\n\n3. **Update Content**\n   - Modify `index.html` to update your site's content\n   - Push changes to the `main` branch\n   ```bash\n   git add index.html\n   git commit -m \"Update content\"\n   git push origin main\n   ```\n\n4. **Access Your Site**\n   - Your site will be available at: `https://\u003cusername\u003e.github.io/gh-deployment-workflow/`\n   - Check the Actions tab for deployment status\n\n## Troubleshooting\n\nIf your deployment fails:\n1. Check the Actions tab for detailed error messages\n2. Verify repository permissions in Settings \u003e Actions \u003e General\n3. Ensure GitHub Pages is enabled and configured correctly\n4. Confirm all workflow permissions are set properly\n\n## Resources \u0026 Further Reading\n\n- **Project Page**: [GitHub Actions Deployment Workflow on roadmap.sh](https://roadmap.sh/projects/github-actions-deployment-workflow)\n- [GitHub Actions Documentation](https://docs.github.com/en/actions)\n- [GitHub Pages Documentation](https://docs.github.com/en/pages)\n- [Official GitHub Pages Actions](https://github.com/actions/configure-pages)\n\nblog published at www.nikhilmishra.live\n\n## License\n\nThis project is open source and available under the MIT License.\n\n---\n\nFeel free to use this template for your own GitHub Pages deployments! Check out the [roadmap.sh project page](https://roadmap.sh/projects/github-actions-deployment-workflow) for more ideas and enhancements.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaalpanikh%2Fgh-deployment-workflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaalpanikh%2Fgh-deployment-workflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaalpanikh%2Fgh-deployment-workflow/lists"}