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.

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
Changes from 1 commit
Commits
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
Next Next commit
use gitlab CI env variable for project name
  • Loading branch information
gregoiredx authored Oct 18, 2019
commit 2ea2a6ffe3ce1be08b5c2fa8ce534859bfbaee75
2 changes: 1 addition & 1 deletion docs/guide/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Typically, your static website will be hosted on https://yourUserName.gitlab.io/

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