GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → crazy-max → Ghaction Github Pages

crazy-max / Ghaction Github Pages

Licence: mit
GitHub Action to deploy to GitHub Pages

Programming Languages

typescript
32286 projects

Labels

deploymentgithub-pages

Projects that are alternatives of or similar to Ghaction Github Pages

GitHub-Education-Portfolio
A portfolio made using React and tools from GitHub Student Developer Pack
Stars: ✭ 50 (-67.32%)
Mutual labels:  github-pages, deployment
Ghpages
Deploy arbitrary static assets through GitHub Actions
Stars: ✭ 169 (+10.46%)
Mutual labels:  github-pages, deployment
Jekyll Github Deploy
Jekyll Site Automated Deployer to GitHub Pages
Stars: ✭ 67 (-56.21%)
Mutual labels:  github-pages, deployment
actions-publish-gh-pages
🍣 A GitHub Action to publish static website using GitHub Pages
Stars: ✭ 12 (-92.16%)
Mutual labels:  github-pages, deployment
Git Directory Deploy
deploy a directory as a git branch
Stars: ✭ 526 (+243.79%)
Mutual labels:  github-pages, deployment
Gulp Gh Pages
A gulp 4 plugin to publish contents to Github pages
Stars: ✭ 611 (+299.35%)
Mutual labels:  github-pages, deployment
Github Pages Deploy Action
Automatically deploy your project to GitHub Pages using GitHub Actions. This action can be configured to push your production-ready code into any branch you'd like.
Stars: ✭ 2,507 (+1538.56%)
Mutual labels:  github-pages, deployment
Terraform Vsphere Kubespray
Deploy a Kubernetes HA cluster on VMware vSphere
Stars: ✭ 141 (-7.84%)
Mutual labels:  deployment
Chart Releaser Action
A GitHub Action to turn a GitHub project into a self-hosted Helm chart repo, using helm/chart-releaser CLI tool
Stars: ✭ 146 (-4.58%)
Mutual labels:  github-pages
Bornmay
Awesome Github Profile Readme. Github ReadMe Github Profile Readme Dynamic Github ReadMe Dynamic Github Profile ReadMe. Please Star and Fork
Stars: ✭ 140 (-8.5%)
Mutual labels:  github-pages
Exoframe Server
Exoframe is a self-hosted tool that allows simple one-command deployments using Docker
Stars: ✭ 139 (-9.15%)
Mutual labels:  deployment
Openwhisk Devtools
Development tools for building and deploying Apache OpenWhisk
Stars: ✭ 141 (-7.84%)
Mutual labels:  deployment
Docker Github Pages
🐳 Alpine Docker Image for GitHub Pages and Jekyll powered sites
Stars: ✭ 147 (-3.92%)
Mutual labels:  github-pages
Git Wiki Theme
A revolutionary full-featured wiki for github pages and jekyll. You don't need to compile it!
Stars: ✭ 139 (-9.15%)
Mutual labels:  github-pages
Gottovote
GotToVote is a toolkit of simple web and SMS services that help citizens get to the ballot box informed and ready to vote. Kenya version accessible at https://kenya.gottovote.cc
Stars: ✭ 150 (-1.96%)
Mutual labels:  github-pages
Bahn.guru
Deutsche Bahn ticket price calendar.
Stars: ✭ 139 (-9.15%)
Mutual labels:  deployment
Kickster
Worry-free deploying to GitHub Pages using Jekyll
Stars: ✭ 151 (-1.31%)
Mutual labels:  deployment
Slashdeploy
GitHub Deployments for Slack
Stars: ✭ 150 (-1.96%)
Mutual labels:  deployment
Point
Create and manage shortened URLs with GitHub pages.
Stars: ✭ 146 (-4.58%)
Mutual labels:  github-pages
Alpine Make Vm Image
Make customized Alpine Linux disk image for virtual machines
Stars: ✭ 145 (-5.23%)
Mutual labels:  deployment
View All Similar Projects ➔

GitHub release GitHub marketplace CI workflow Become a sponsor Paypal Donate

About

A GitHub Action to deploy to GitHub Pages

If you are interested, check out my other GitHub Actions!

GitHub Pages

Usage

Workflow

Below is a simple snippet to deploy to GitHub Pages with a dummy HTML page.

A workflow is also available for this repository and deploys everyday to GitHub pages.

name: website

on: push

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/[email protected]
      -
        name: Gen dummy page
        run: |
          mkdir public
          cat > public/index.html <<EOL
          <!doctype html>
          <html>
            <head>
              <title>GitHub Pages deployed!</title>
            </head>
            <body>
              <p>GitHub Pages with <strong>${{ github.sha }}</strong> commit ID has been deployed through <a href="https://github.com/marketplace/actions/github-pages">GitHub Pages action</a> successfully.</p>
            </body>
          </html>
          EOL
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/[email protected]
        with:
          target_branch: gh-pages
          build_dir: public
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Sign commits

You can use the Import GPG GitHub Action along with this one to sign commits:

      -
        name: Import GPG key
        uses: crazy-max/[email protected]
        with:
          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
          git-user-signingkey: true
          git-commit-gpgsign: true
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/[email protected]
        with:
          target_branch: gh-pages
          build_dir: public
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Check availability of GitHub Pages

You can use the GitHub Status Action along with this one to check availability of GitHub Pages before deploying:

      -
        name: Check GitHub Pages status
        uses: crazy-max/[email protected]
        with:
          pages_threshold: major_outage
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/[email protected]
        with:
          target_branch: gh-pages
          build_dir: public
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Customizing

inputs

Following inputs can be used as step.with keys

Name Type Description
domain String Git domain (default github.com)
repo String GitHub repository where assets will be deployed (default $GITHUB_REPOSITORY)
target_branch String Git branch where assets will be deployed (default gh-pages)
keep_history Bool Create incremental commit instead of doing push force (default false)
allow_empty_commit Bool Allow an empty commit to be created (default true)
build_dir String Build directory to deploy (required)
committer String Committer name and email address as Display Name <[email protected]> (defaults to the GitHub Actions bot user)
author String Author name and email address as Display Name <[email protected]> (defaults to the GitHub Actions bot user)
commit_message String Commit message (default Deploy to GitHub pages)
fqdn String Write the given domain name to the CNAME file
jekyll Bool Allow Jekyll to build your site (default true)

environment variables

Following environment variables can be used as step.env keys

Name Description
GITHUB_TOKEN GITHUB_TOKEN as provided by secrets
GH_PAT Use a Personal Access Token if you want to deploy to another repo

Keep up-to-date with GitHub Dependabot

Since Dependabot has native GitHub Actions support, to enable it on your GitHub repo all you need to do is add the .github/dependabot.yml file:

version: 2
updates:
  # Maintain dependencies for GitHub Actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "daily"

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬 You can also support this project by becoming a sponsor on GitHub 👏 or by making a Paypal donation to ensure this journey continues indefinitely! 🚀

Thanks again for your support, it is much appreciated! 🙏

License

MIT. See LICENSE for more details.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].