diff --git a/.circleci/config.yml b/.circleci/config.yml index 27f9025..450ffde 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -54,8 +54,8 @@ jobs: steps: - attach_workspace: at: ~/ - - run: name: Push UI bundle archive to GitHub command: | - ghr -replace -u ${GITHUB_USER} -r ${GITHUB_REPO} $(cat release.version) build/ui-bundle.zip + source release.version + ghr -replace -u "${GITHUB_USER}" -r "${GITHUB_REPO}" -n "${codename}" "v${release}" build/ui-bundle.zip diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 447b5a0..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,55 +0,0 @@ -image: node:10.14.2-alpine -stages: [setup, verify, deploy] -yarn: - stage: setup - cache: - paths: - - .yarn-cache/ - script: - - &run_yarn - yarn --cache-folder=.yarn-cache --pure-lockfile > /dev/null -lint: - stage: verify - cache: &pull_cache - policy: pull - paths: - - .yarn-cache/ - script: - - *run_yarn - - node_modules/.bin/gulp lint -bundle-stable: - stage: deploy - only: - - master@antora/antora-ui-default - cache: *pull_cache - script: - - *run_yarn - - node_modules/.bin/gulp bundle - artifacts: - paths: - - build/ui-bundle.zip -bundle-dev: - stage: deploy - except: - - master - cache: *pull_cache - script: - - *run_yarn - - node_modules/.bin/gulp bundle - artifacts: - expire_in: 1 day # unless marked as keep from job page - paths: - - build/ui-bundle.zip -pages: - stage: deploy - only: - - master@antora/antora-ui-default - cache: *pull_cache - script: - - *run_yarn - - node_modules/.bin/gulp preview:build - # FIXME figure out a way to avoid copying these files to preview site - - rm -rf public/_/{helpers,layouts,partials} - artifacts: - paths: - - public diff --git a/README.adoc b/README.adoc index 3a476ba..ee02785 100644 --- a/README.adoc +++ b/README.adoc @@ -1,37 +1,27 @@ -= Antora Default UI += Antora OpenNMS UI // Settings: :experimental: :hide-uri-scheme: + // Project URLs: -:url-project: https://gitlab.com/antora/antora-ui-default -:url-preview: https://antora.gitlab.io/antora-ui-default -:url-ci-pipelines: {url-project}/pipelines -:img-ci-status: {url-project}/badges/master/pipeline.svg -// External URLs: +:url-project: https://github.com/opennms-forge/antora-ui-opennms :url-antora: https://antora.org -:url-git: https://git-scm.com -:url-git-dl: {url-git}/downloads -:url-gulp: http://gulpjs.com -:url-opendevise: https://opendevise.com -:url-node: https://nodejs.org -:url-nvm: https://github.com/creationix/nvm -:url-nvm-install: {url-nvm}#installation -:url-yarn: https://yarnpkg.com +:url-ci-pipelines: https://circleci.com/gh/opennms-forge/workflows/antora-ui-opennms +:img-ci-status: https://circleci.com/gh/opennms-forge/antora-ui-opennms.svg?style=svg image:{img-ci-status}[CI Status (GitLab CI), link={url-ci-pipelines}] This project is an archetype that demonstrates how to produce a UI bundle for use in a documentation site generated with {url-antora}[Antora]. -You can see a preview of the default UI at {url-preview}. -== Use the Default UI +== Use the OpenNMS Antora UI -If you want to use the default UI for your Antora-generated site, add the following UI configuration to your playbook: +If you want to use the UI for your Antora-generated site, add the following UI configuration to your playbook: [source,yaml,subs=attributes+] ---- ui: bundle: - url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable + url: https://github.com/opennms-forge/antora-ui-opennms/releases/download/v1.0.0/ui-bundle.zip snapshot: true ---- @@ -46,10 +36,10 @@ A more comprehensive tutorial will be made available in the documentation. To preview and bundle the default UI, you need the following software on your computer: -* {url-git}[git] (command: `git`) -* {url-node}[Node] (command: `node`) -* {url-gulp}[Gulp CLI] (command: `gulp`) -* {url-yarn}[Yarn] (command: `yarn`) +* command: `git` +* command: `node` +* command: `gulp` +* command: `yarn` ==== git @@ -57,7 +47,7 @@ First, make sure you have git installed. $ git --version -If not, {url-git-dl}[download and install] the git package for your system. +If not, download and install the git package for your system. ==== Node @@ -69,7 +59,7 @@ If this command fails with an error, you don't have Node installed. If the command doesn't report a Node LTS version (e.g., v10.14.2), you don't have a suitable version of Node installed. While you can install Node from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to install and manage Node. -Follow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine. +Follow the nvm installation instructions to set up nvm on your machine. Once you've installed nvm, open a new terminal and install Node 10 using the following command: @@ -173,4 +163,4 @@ See link:LICENSE[] to find the full license text. == Authors -Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc]. +Development of Antora is led and sponsored by OpenDevise Inc. diff --git a/release.version b/release.version index afaf360..054ab2c 100644 --- a/release.version +++ b/release.version @@ -1 +1,2 @@ -1.0.0 \ No newline at end of file +release="1.0.0" +codename="Stunt Car Racer" \ No newline at end of file