Skip to content
activity

GitHub Action

Vue to Github Pages

1.0.1 Latest version

Vue to Github Pages

activity

Vue to Github Pages

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

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Vue to Github Pages

uses: xRealNeon/VuePagesAction@1.0.1

Learn more about this action in xRealNeon/VuePagesAction

Choose a version

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/VuePagesAction@1.0.1
      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 CI@example.com ❌
gitname Git commit name CI ❌
gitmsg Git commit message deploy ❌
cname Custom domain - ❌
useyarn Use yarn to build false ❌