Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alex-page/blazing-fast-gh-pages-deploy
🔥 The most blazingest action to deploy your GitHub pages website
https://github.com/alex-page/blazing-fast-gh-pages-deploy
blazingly-fast deploy github-actions github-pages static-site
Last synced: 10 days ago
JSON representation
🔥 The most blazingest action to deploy your GitHub pages website
- Host: GitHub
- URL: https://github.com/alex-page/blazing-fast-gh-pages-deploy
- Owner: alex-page
- License: mit
- Archived: true
- Created: 2019-09-14T00:42:19.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-28T05:26:46.000Z (over 2 years ago)
- Last Synced: 2024-10-26T10:52:12.245Z (15 days ago)
- Topics: blazingly-fast, deploy, github-actions, github-pages, static-site
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/blazing-fast-github-pages-deploys
- Size: 589 KB
- Stars: 34
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-blazingly-fast - blazing-fast-gh-pages-deploy - 🔥 The most blazingest action to deploy your GitHub pages website (JavaScript)
README
**This Action is archived.** I recommend using [Custom GitHub Actions workflows](https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/) to deploy to GitHub pages. Here is a code [example of a migration](https://github.com/alex-page/alexpage.dev/commit/717efbcc57d0c8ce9f64d28526263610ea444823) off this GitHub action.
---
# Blazing fast GitHub Pages deploy
> 🔥 The most blazingest action to deploy your GitHub pages website
## Why did you make another action to deploy to GitHub pages?
This GitHub action uses JavaScript for maximum speed 🚀.
> Using a [JavaScript action](https://help.github.com/en/articles/about-actions#javascript-actions) simplifies the action code and executes faster than a Docker container action.
## Usage
1. Create a new workflow by adding `.github/workflows/deploy.yml` to your project.
2. Create a [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
3. [Create a secret](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) containing the personal access token, call it `GH_PAT`
4. Modify the [workflow options](#workflow-options) for your project
Here is an example `deploy.yml` file:
```yml
name: Blazing fast GitHub Pages deploy
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
- name: npm install, test and build
run: |
npm install
npm run test
npm run build
- name: Deploy site to gh-pages branch
uses: alex-page/[email protected]
with:
repo-token: ${{ secrets.GH_PAT }}
```
## Workflow options
If you want a more custom experience you can add these values. For more detailed explanation of the workflow file, check out the [GitHub documentation](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
| Setting | Description | Default value | Required |
| --- | --- | --- | --- |
| `repo-token` | The personal access token | `${{ secrets.GH_PAT }}` | `true` |
| `site-directory` | The site directory | `_site` | `false` |
| `commit-message` | The commit message for the branch | Deployed using Blazing fast GitHub Pages deploy action | `false` |
| `deploy-branch` | The branch to deploy the built website to | `gh-pages` | `false` |
## Troubleshooting
> "could not read Username for 'https://github.com': No such device or address"
This is due to the deployed site folder containing a `.git` directory. It is recommended to build the site in a new folder for deployment.
## Release History
- v1.1.0 - Use environment variables, remove @actions/github dependency, remove TypeScript
- v1.0.3 - Use environment variable for repository
- v1.0.2 - Use head_commit for when there is no push
- v1.0.1 - Return on error
- v1.0.0 - Remove required name and email. Fix breaking bug with incorrect repository URL.
- v0.0.1 - TypesScript, use callback instead of async
- v0.0.0 - Initial release