Publishing to gitlab-pages

[tjaeggi]

Description

In your Documentation you publish a .gitlab-ci.yml like this:

pages:
  stage: deploy
  image: python:latest
  script:
    - pip install zensical
    - zensical build --clean 
  pages:
    publish: public
  rules:
    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

This creates a fatal error. With this correction publish: site, it works:

pages:
  stage: deploy
  image: python:latest
  script:
    - pip install zensical
    - zensical build --clean
  pages:
    publish: site
  rules:
    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

Related links

• Reporting a docs issue in
• Section: GitLab Pages

Proposed change

Correct it

Before submitting

• I have read and followed the documentation issue guidelines.
• I have attached the links to the affected sections of the documentation

[squidfunk]

Thanks for reporting. Things were changed in in #58. Maybe @carloseguevara can take a look, since he proposed the change? We're not users of GitLab ourselves.

[carloseguevara]

Absolutely, I can handle it!

@tjaeggi Could you please tell me what the fatal error message is?

[carloseguevara]

Maybe you missed the warning after that:

!!! warning "Prerequisites" Make sure to change site_dir to public in your configuration as GitLab requires this.

With this configuration, you change the build folder from "site" to "public" and make match with the default gitlab configuration.

In other words, if you put your gitlab code "pages: publish: site" you don't need to change the zensical configuration. In the documentation we change the zensical configuration to match with the default folder expected by gitlab, so you can use or "pages: true" (more simple but we assume "public" as default folder by gitlab) or "pages: publish: public" (more explicit to avoid posible changes in gitlab site).

[squidfunk]

Okay, so then I misunderstood your PR. I thought GitLab requires it to be public. It this is not the case, we should change it back to site, since this is the default.