Commit c5fb7128 authored by Dan Allen's avatar Dan Allen

configure CI job to publish preview site to GitLab Pages

- change output folder for preview site to public (requirement of GitLab Pages)
- add the public folder to .gitignore file
- add job to CI build that publishes preview site from master branch
- add link to preview site to the README
parent 28d71bc4
/build/
/node_modules/
/public/
......@@ -2,15 +2,16 @@ image: node:8
stages:
- setup
- verify
- deploy
yarn:
stage: setup
script:
- npm install -g yarn
- yarn --cache-folder=.yarn-cache
cache:
paths:
- node_modules/
- .yarn-cache/
script:
- npm install -g yarn
- yarn --cache-folder=.yarn-cache
lint:
stage: verify
cache:
......@@ -18,3 +19,15 @@ lint:
paths:
- node_modules/
script: node_modules/.bin/gulp lint
pages:
stage: deploy
only:
- master
cache:
policy: pull
paths:
- node_modules/
script: node_modules/.bin/gulp build:preview
artifacts:
paths:
- public
= Antora Default UI
// Project URIs:
:uri-project: https://gitlab.com/antora/antora-ui-default
:uri-preview: https://antora.gitlab.io/antora-ui-default
:uri-ci-pipelines: {uri-project}/pipelines
:img-ci-status: {uri-project}/badges/master/pipeline.svg
......@@ -8,6 +9,8 @@ image:{img-ci-status}[CI Status (GitLab CI), link={uri-ci-pipelines}]
This project is an archetype that demonstrates how to produce a UI bundle for use in an Antora-based documentation pipeline.
You can preview the default UI at {uri-preview}.
== Copyright and License
Copyright (C) 2017 OpenDevise Inc. and the Antora Project.
......
......@@ -14,7 +14,7 @@ const preview = require('./tasks/preview')
const bundleName = 'ui'
const buildDir = 'build'
const previewSiteSrcDir = 'preview-site-src'
const previewSiteDestDir = path.join(buildDir, 'preview-site')
const previewSiteDestDir = 'public'
const srcDir = 'src'
const destDir = path.join(previewSiteDestDir, '_')
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment