Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use gitlab CI env variable for project name #4716

Merged
merged 3 commits into from
Nov 7, 2019
Merged

use gitlab CI env variable for project name #4716

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ea2a6f
use gitlab CI env variable for project name
gregoiredx Oct 18, 2019
c9cc06f
add explanation on CI_PROJECT_NAME env var
gregoiredx Oct 26, 2019
a458b65
docs: gzip support in GitLab Pages
gregoiredx Nov 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/guide/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,22 +130,24 @@ pages: # the job must be named pages
- npm run build
- mv public public-vue # GitLab Pages hooks on the public folder
- mv dist public # rename the dist folder (result of npm run build)
# optionally, you can activate gzip support wih the following line:
- find public -type f -regex '.*\.\(htm\|html\|txt\|text\|js\|css\)$' -exec gzip -f -k {} \;
artifacts:
paths:
- public # artifact path must be /public for GitLab Pages to pick it up
only:
- master
```

Typically, your static website will be hosted on https://yourUserName.gitlab.io/yourProjectName, so you will also want to create an initial `vue.config.js` file to [update the `BASE_URL`](https://github.com/vuejs/vue-cli/tree/dev/docs/config#baseurl) value to match:
Typically, your static website will be hosted on https://yourUserName.gitlab.io/yourProjectName, so you will also want to create an initial `vue.config.js` file to [update the `BASE_URL`](https://github.com/vuejs/vue-cli/tree/dev/docs/config#baseurl) value to match your project name (the [`CI_PROJECT_NAME` environment variable](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) contains this value):


```javascript
// vue.config.js file to be place in the root of your repository
// make sure you update `yourProjectName` with the name of your GitLab project
module.exports = {
publicPath: process.env.NODE_ENV === 'production'
? '/yourProjectName/'
? '/' + process.env.CI_PROJECT_NAME + '/'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this!

While I agree with the changing hardcoded value to predefined GitLab CI variable, this also requires removing a comment above the export:

// make sure you update `yourProjectName` with the name of your GitLab project

Also, it would be nice to explain than the project name is a predefined variable in GitLab CI.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, you're right. thanks for taking the time to review this, I've added some explanations and a link to gitlab docs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, I would advice on using gzip compression on gitlab pages.
It's just one line to add in the .gitlab-ci.yml file, see https://docs.gitlab.com/ee/user/project/pages/introduction.html#serving-compressed-assets
Do you think I could do this in this PR or open a new one?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I would agree on using gzip! Let's add it to this PR

: '/'
}
```
Expand Down