Browse Source

docs: Use the basic-deploy-docs CI template

pipelines/786320
Kévin Commaille 1 year ago
parent
commit
0ba4b655c0
No known key found for this signature in database
GPG Key ID: C971D9DBC9D678D
  1. 6
      .gitlab-ci.yml
  2. 17
      .gitlab-ci/docs.yml
  3. 18
      .gitlab-ci/publish_docs.yml
  4. 23
      .gitlab-ci/test.yml

6
.gitlab-ci.yml

@ -17,9 +17,9 @@ include:
- local: .gitlab-ci/run_checks.yml - local: .gitlab-ci/run_checks.yml
- local: .gitlab-ci/build.yml - local: .gitlab-ci/build.yml
- local: .gitlab-ci/test.yml - local: .gitlab-ci/test.yml
- local: .gitlab-ci/publish_docs.yml - component: "gitlab.gnome.org/GNOME/citemplates/basic-deploy-docs@master"
rules: inputs:
- if: $CI_COMMIT_BRANCH == "main" docs-job-name: "build-docs"
- local: .gitlab-ci/publish_nightly.yml - local: .gitlab-ci/publish_nightly.yml
rules: rules:
- if: $CI_COMMIT_BRANCH == "main" - if: $CI_COMMIT_BRANCH == "main"

17
.gitlab-ci/docs.yml

@ -1,17 +0,0 @@
.docs:
image: 'quay.io/gnome_infrastructure/gnome-runtime-images:gnome-master'
tags:
- flatpak
script:
- flatpak install --user --noninteractive org.freedesktop.Sdk.Extension.rust-nightly//24.08
# We want to use rust-nightly to build the app.
- sed -i 's|"org.freedesktop.Sdk.Extension.rust-stable"|"org.freedesktop.Sdk.Extension.rust-nightly"|g' ${MANIFEST_PATH}
- sed -i 's|/rust-stable/bin|/rust-nightly/extra/sdk/rust-nightly/bin|g' ${MANIFEST_PATH}
- flatpak-builder --keep-build-dirs --user --disable-rofiles-fuse --stop-at=${FLATPAK_MODULE} flatpak_app --repo=repo ${BRANCH:+--default-branch=$BRANCH} ${MANIFEST_PATH}
- echo "ninja src/doc" | flatpak-builder --disable-rofiles-fuse --build-shell=${FLATPAK_MODULE} flatpak_app ${MANIFEST_PATH}
- mv .flatpak-builder/build/${FLATPAK_MODULE}/_flatpak_build/src/doc ${DOCS_FOLDER}
- chmod -R a=rwx ${DOCS_FOLDER}
dependencies: []
artifacts:
paths:
- $DOCS_FOLDER

18
.gitlab-ci/publish_docs.yml

@ -1,18 +0,0 @@
# Build and publish the docs
include: '.gitlab-ci/docs.yml'
pages:
extends:
- .docs
stage: deploy
variables:
DOCS_FOLDER: "public"
rules:
- changes:
- src/**/*
- Cargo.lock
- Cargo.toml
when: always
- when: manual
allow_failure: true

23
.gitlab-ci/test.yml

@ -1,7 +1,5 @@
# Tests after the app is built. # Tests after the app is built.
include: '.gitlab-ci/docs.yml'
# Validate the metainfo with Flathub's tool. # Validate the metainfo with Flathub's tool.
lint-metainfo: lint-metainfo:
stage: test stage: test
@ -37,10 +35,19 @@ rust-tests:
# Test that there are no errors in the docs. # Test that there are no errors in the docs.
build-docs: build-docs:
extends:
- .docs
stage: test stage: test
variables: image: 'quay.io/gnome_infrastructure/gnome-runtime-images:gnome-master'
DOCS_FOLDER: "doc" tags:
rules: - flatpak
- if: $CI_COMMIT_BRANCH != "main" script:
- flatpak install --user --noninteractive org.freedesktop.Sdk.Extension.rust-nightly//24.08
# We want to use the nightly toolchain inside the build terminal.
- sed -i 's|"org.freedesktop.Sdk.Extension.rust-stable"|"org.freedesktop.Sdk.Extension.rust-nightly"|g' ${MANIFEST_PATH}
- sed -i 's|/rust-stable/bin|/rust-nightly/extra/sdk/rust-nightly/bin|g' ${MANIFEST_PATH}
- flatpak-builder --keep-build-dirs --user --disable-rofiles-fuse --stop-at=${FLATPAK_MODULE} flatpak_app --repo=repo ${BRANCH:+--default-branch=$BRANCH} ${MANIFEST_PATH}
- echo "ninja src/doc" | flatpak-builder --disable-rofiles-fuse --build-shell=${FLATPAK_MODULE} flatpak_app ${MANIFEST_PATH}
- tar --auto-compress --create --file "${CI_PROJECT_DIR}/${CI_PROJECT_NAME}-docs.tar.gz" --directory ".flatpak-builder/build/${FLATPAK_MODULE}/_flatpak_build/src/doc" .
dependencies: []
artifacts:
paths:
- ${CI_PROJECT_NAME}-docs.tar.gz

Loading…
Cancel
Save