GitHub Action
Vue to Github Pages
1.0.1
Latest version
This Action will Build your Vue Project and deploy it to Github Pages
- For Vue 2 : Create the
vue.config.js
file - For Vue 3 : You should have a
vite.config.js
or avite.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
orvite.config.ts
(and rename "YourRepoName" to your repo name)
export default defineConfig({
... // Already existing configurations
base: '/YourRepoName/'
});
- 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
- Go to Settings -> Scroll down to GitHub Pages -> Select
gh-pages
as branch and/
as directory
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 | β |