Skip to content

Vue to Github Pages

Actions
This Action will Build your Vue Project and deploy it to Github Pages
1.0.1
Latest
Star (77)

Tags

 (1)

Build Vue and deploy it to Github Pages 🚀

This Action will Build your Vue Project and deploy it to Github Pages

Getting Started 🎉

  • For Vue 2 : Create the vue.config.js file
  • For Vue 3 : You should have a vite.config.js or a vite.config.ts file at the root of your directory. Create one if you don't.
  • For Vue 2 : Add this to your vue.config.js (and rename "YourRepoName" to your repo name)
module.exports = {
    publicPath: '/YourRepoName/'
}
  • For Vue 3 : Add this to you vite.config.js or vite.config.ts (and rename "YourRepoName" to your repo name)
export default defineConfig({
  ... // Already existing configurations
  base: '/YourRepoName/'
});
  1. Create a Github Actions Workflow file and add this to it (and replace "YourGithubName" and "YourRepoName" with the names)
name: Build Vue
on: [push]
jobs:
  build_vue:
    runs-on: ubuntu-latest
    name: Build Vue
    steps:
    - uses: actions/checkout@v2
    - id: Build-Vue
      uses: xRealNeon/[email protected]
      with:
        username: 'YourGithubName'
        reponame: 'YourRepoName'
        token: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged
  1. Go to Settings -> Scroll down to GitHub Pages -> Select gh-pages as branch and / as directory

Options 🔧

Name Description Default Required
username Your username -
reponame Your repository name -
token Please leave this line unchanged -
gitemail Git commit email [email protected]
gitname Git commit name CI
gitmsg Git commit message deploy
cname Custom domain -
useyarn Use yarn to build false

Vue to Github Pages is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

This Action will Build your Vue Project and deploy it to Github Pages
1.0.1
Latest

Tags

 (1)

Vue to Github Pages is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.