Commit 033d607a authored by DJOUNANG NANA Guy Rostan's avatar DJOUNANG NANA Guy Rostan
Browse files

chore: delete cargo_doc and cypress_run to recreate each other on new branch

parent 24e55334
Loading
Loading
Loading
Loading

jobs/cargo_doc/README.md

deleted100644 → 0
+0 −32
Original line number Diff line number Diff line
## Objective

Cargo_doc aims to generate rustdoc for your project

## How to use it

1. <Your steps>
1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.
    ```yaml
      - remote: 'https://jobs.r2devops.io/latest/cargo_doc.yml'
    ```
1. If you need to customize the job (stage, variables, ...) 👉 check the [jobs
   customization](/use-the-hub/#jobs-customization)
1. Well done, your job is ready to work ! 😀

## Job details

* Job name: `cargo_doc`
* Docker image:
[`rust:1.57-buster`](https://hub.docker.com/r/_/rust)
* Default stage: `build`
* When: `always`

### Variables

| Name | Description | Default |
| ---- | ----------- | ------- |
| ONLY_LIB | Generate documentation of current library only | `false` | 
| PROJECT_ROOT | Relative to root of your repository, it is the path to your rust project | `.` | 
| RELEASE_MODE | Generate documentation with optimization for release | `true` | 
| OUTPUT_FOLDER | Directory where are output files | `website_build` | 
| ADDITIONAL_OPTIONS | Possibility to add more options into the command | ` ` | 

jobs/cargo_doc/cargo_doc.yml

deleted100644 → 0
+0 −17
Original line number Diff line number Diff line
cargo_doc:
    image: rust:1.57-buster
    stage: build
    variables:
      ONLY_LIB: 'false'
      PROJECT_ROOT: '.'
      RELEASE_MODE: 'true'
      OUTPUT_FOLDER: "website_build"
      ADDITIONAL_OPTIONS: ''
    script:
      - cd $PROJECT_ROOT
      - cargo doc --target-dir ${OUTPUT_FOLDER} --lib=$ONLY_LIB --release=$RELEASE_MODE $ADDITIONAL_OPTIONS
    artifacts:
      when: always
      expose_as: "Cargo_doc build"
      paths:
        - $OUTPUT_FOLDER

jobs/cargo_doc/job.yml

deleted100644 → 0
+0 −9
Original line number Diff line number Diff line
name: cargo_doc
description: Cargo_doc aims to generate rustdoc for your project
default_stage: build
icon: 🧠
maintainer: DjNaGuRo
license: MIT
images:
  rust:1.57-buster
tools:
 No newline at end of file
+0 −0

Empty file deleted.

jobs/cargo_doc/versions/0.1.0.md

deleted100644 → 0
+0 −1
Original line number Diff line number Diff line
* Initial version
 No newline at end of file
Loading