Browse Source

ci: Depend on rust nightly for docs generation again

Also add a job to test docs generation for MRs
fractal-8
Kévin Commaille 2 years ago
parent
commit
5acfd1305f
No known key found for this signature in database
GPG Key ID: C971D9DBC9D678D
  1. 17
      .gitlab-ci/pages.yaml
  2. 16
      .gitlab-ci/publish_docs.yml
  3. 12
      .gitlab-ci/test.yml
  4. 2
      README.md
  5. 23
      src/meson.build

17
.gitlab-ci/pages.yaml

@ -0,0 +1,17 @@
.pages:
image: 'quay.io/gnome_infrastructure/gnome-runtime-images:gnome-master'
tags:
- flatpak
script:
- flatpak install --user --noninteractive org.freedesktop.Sdk.Extension.rust-nightly//24.08beta
# We want to use rust-nightly to build the app, but mold is in rust-stable
- sed -i 's|"org.freedesktop.Sdk.Extension.rust-stable"|"org.freedesktop.Sdk.Extension.rust-stable","org.freedesktop.Sdk.Extension.rust-nightly"|g' ${MANIFEST_PATH}
- sed -i 's|:/usr/lib/sdk/rust-stable/bin|:/usr/lib/sdk/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

16
.gitlab-ci/publish_docs.yml

@ -1,19 +1,11 @@
# Build and publish the docs # Build and publish the docs
include: '.gitlab-ci/pages.yaml'
pages: pages:
stage: deploy stage: deploy
image: 'quay.io/gnome_infrastructure/gnome-runtime-images:gnome-master' variables:
tags: DOCS_FOLDER: "public"
- flatpak
script:
- 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 public
- chmod -R a=rwx public
dependencies: []
artifacts:
paths:
- 'public'
rules: rules:
- changes: - changes:
- src/**/* - src/**/*

12
.gitlab-ci/test.yml

@ -1,5 +1,7 @@
# Tests after the app is built. # Tests after the app is built.
include: '.gitlab-ci/pages.yaml'
# Validate the metainfo with Flathub's tool. # Validate the metainfo with Flathub's tool.
metainfo: metainfo:
stage: test stage: test
@ -14,3 +16,13 @@ metainfo:
# Test also with the pedantic and strict flags. # Test also with the pedantic and strict flags.
- appstreamcli validate --pedantic --explain --strict ${METAINFO} - appstreamcli validate --pedantic --explain --strict ${METAINFO}
needs: ["build@x86_64"] needs: ["build@x86_64"]
# Test that there are no errors in the docs.
test-pages:
extends:
- .pages
stage: test
variables:
DOCS_FOLDER: "doc"
rules:
- if: $CI_COMMIT_BRANCH != "main"

2
README.md

@ -1,6 +1,6 @@
[![Our chat room](https://img.shields.io/matrix/fractal-gtk:matrix.org?color=blue&label=%23fractal%3Agnome.org&logo=matrix)](https://matrix.to/#/#fractal:gnome.org) [![Our chat room](https://img.shields.io/matrix/fractal-gtk:matrix.org?color=blue&label=%23fractal%3Agnome.org&logo=matrix)](https://matrix.to/#/#fractal:gnome.org)
[![Our Gitlab project](https://img.shields.io/badge/gitlab.gnome.org%2F-World%2FFractal-green?logo=gitlab)](https://gitlab.gnome.org/World/fractal/) [![Our Gitlab project](https://img.shields.io/badge/gitlab.gnome.org%2F-World%2FFractal-green?logo=gitlab)](https://gitlab.gnome.org/World/fractal/)
[![Our documentation](https://img.shields.io/badge/%F0%9F%95%AE-Docs-B7410E?logo=rust)](https://world.pages.gitlab.gnome.org/fractal/fractal/index.html) [![Our documentation](https://img.shields.io/badge/%F0%9F%95%AE-Docs-B7410E?logo=rust)](https://world.pages.gitlab.gnome.org/fractal/)
[![Official package](https://img.shields.io/flathub/downloads/org.gnome.Fractal?logo=flathub)](https://flathub.org/apps/org.gnome.Fractal) [![Official package](https://img.shields.io/flathub/downloads/org.gnome.Fractal?logo=flathub)](https://flathub.org/apps/org.gnome.Fractal)
# Fractal # Fractal

23
src/meson.build

@ -66,15 +66,15 @@ custom_target(
) )
rustdoc_flags = ' '.join([ rustdoc_flags = ' '.join([
# FIXME: Unstable features are disabled because we need Rust nightly '-Zunstable-options',
# '-Zunstable-options', '--enable-index-page',
# '--enable-index-page', '--extern-html-root-url=gio=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/',
# '--extern-html-root-url=gio=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/', '--extern-html-root-url=glib=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/',
# '--extern-html-root-url=glib=https://gtk-rs.org/gtk-rs-core/stable/latest/docs/', '--extern-html-root-url=gsk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/',
# '--extern-html-root-url=gsk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', '--extern-html-root-url=gdk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/',
# '--extern-html-root-url=gdk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', '--extern-html-root-url=gtk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/',
# '--extern-html-root-url=gtk4=https://gtk-rs.org/gtk4-rs/stable/latest/docs/', '--extern-html-root-url=libadwaita=https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/',
# '--extern-html-root-url=libadwaita=https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/', '--cfg=docsrs',
'-Dwarnings', '-Dwarnings',
]) ])
doc_env = ['RUSTDOCFLAGS=' + rustdoc_flags ] doc_env = ['RUSTDOCFLAGS=' + rustdoc_flags ]
@ -103,10 +103,7 @@ custom_target(
command: [ command: [
'env', cargo_env + doc_env, 'env', cargo_env + doc_env,
cargo, 'doc', cargo, 'doc',
cargo_options + doc_deps + [ cargo_options + doc_deps + ['--no-deps', '-Zrustdoc-map'] ,
'--no-deps',
#'-Zrustdoc-map'
] ,
], ],
) )

Loading…
Cancel
Save