Add GitLab CI build instructions #2

Open ronaldtse opened 3 years ago

IEEE SA Open needs to run the Aperis editor on their GitLab platform, we should allow that.

Closed mistakenly. In 1.0.0-alpha22, configurable deployment setup is supported. What remains to be done is adding GitLab Pages/GitHub pages deployment setup configurations here.

As of Aperis Paneron extension v1 alpha 26, the following GitLab Pages deployment configuration added:

image: "node:14"
pages:
  cache:
    paths: [node_modules]
  artifacts:
    paths: [dist]
  only: [master]
  script:
    - yarn install
    - yarn build

Testing pending.

Updated Aperis extension to support GitLab Pages deployment under URL subpath (released in aperis-site v1 alpha 27).

Users will need to set “prefix” in site settings to match their GitLab project name if they are deploying under default domain provided by GitLab Pages.

To be more specific, GitLab Pages by default deploys gitlab.com/someuser/somerepo under someuser.gitlab.io/somerepo, so repository manager who shares the repository on GitLab and wants to publish it on GitLab Pages without configuring a custom domain must do two things in Aperis extension GUI Site Settings pane:

Write “GitLab Pages” deployment setup
Specify prefix as “somerepo”

(Note: if custom domain is configured, and the site hosted by GitLab Pages will be made available directly under e.g. somerepo.org, then the prefix should be left empty.)

Currently known issue:

When Aperis site is deployed under URL prefix, logo on top left does not link to prefix, but to top-level / path. Normally we want that, so it is by design (e.g. in case of Glossarist site, where docs are under a prefix /docs/, we want clicking on Glossarist logo in docs to take the user to top-level site root outside docs root). However, if top-level domain is shared between unrelated sites, this becomes undesirable, so we may add an option that tells Aperis pages whether to link header banner logo to configured urlPrefix (e.g., for GitLab pages setup) or straight to / (e.g., for sites like Glossarist.org, current behavior).

Correction: GL Pages deployment under URL prefix works, but only in static mode (JS is being loaded from a wrong place), to be fixed in next version.

Have sought clarification from SA Open to see if they support Pages.

Correction: GL Pages deployment under URL prefix works, but only in static mode (JS is being loaded from a wrong place), to be fixed in next version.

Fixed in alpha 30.

@strogonoff we are told that IEEE SA Open's Pages will be available in 2 weeks time, so perhaps first week of Dec.

paneron / extension-aperis-site

Add GitLab CI build instructions #2