Unverified Commit 4239fc41 authored by GridexX's avatar GridexX
Browse files

Merge branch '640-fix-remove-image_tag-from-readme-in-jobs' into 'latest' 

Resolve "[Fix] - Remove IMAGE_TAG from Readme in jobs"

Closes #640

See merge request r2devops/hub!402
parents 44232007 6c60ebf0

jobs/ansible_playbook/README.md

+7 −7
Original line number Diff line number Diff line 
| `IMAGE_TAG` | The default tag for the docker image | `3.15.1`  |

## Objective



This job will run an [`ansible-playbook`](https://docs.ansible.com/ansible/latest/user_guide/playbooks.html) command to automate deployments. You can install multiple roles from a `requirements.yml` file, see the [documentation](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-multiple-roles-from-a-file).
@@ -13,8 +12,9 @@ This job will run an [`ansible-playbook`](https://docs.ansible.com/ansible/lates 
## Variables



| Name | Description | Default |

| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |

| ---- | ----------- | ------- |

| `ANSIBLE_WORKSPACE` <img width=100/> | The path where is located your ansible project <img width=175/> | `.` <img width=100/> |

| `ANSIBLE_INVENTORY_FILE` <img width=100/> | The inventory file where are described roles and groups. This variable should be specified in `GitLab > CI/CD Settings` as file. <img width=175/> | ` ` <img width=100/>  |

| `SSH_PRIVATE_KEY_FILE` <img width=100/>   | ⚠️ Mandatory variable. The name of your private SSH key. This variable should be specified in `GitLab > CI/CD Settings` as file. <img width=175/>   | ` ` <img width=100/>  |

| `ADDITIONAL_OPTIONS` <img width=100/>     | Other [options](https://docs.ansible.com/ansible/latest/cli/ansible-playbook.html#common-options) you may want to use<img width=175/>             | ` ` <img width=100/>  |
 
| `ANSIBLE_INVENTORY_FILE` | The inventory file where are described roles and groups. This variable should be specified in `GitLab > CI/CD Settings` as file.  | ` ` |

| `SSH_PRIVATE_KEY_FILE` | ⚠️ Mandatory variable. The name of your private SSH key. This variable should be specified in `GitLab > CI/CD Settings` as file. | ` ` |

| `ADDITIONAL_OPTIONS` | Other [options](https://docs.ansible.com/ansible/latest/cli/ansible-playbook.html#common-options) you may want to use | ` ` |

| `IMAGE_TAG` | The default tag for the docker image | `3.15.1` |
 
 No newline at end of file

jobs/artisan_migrate/README.md

+1 −2
Original line number Diff line number Diff line 
| `IMAGE_TAG` | The default tag for the docker image | `7.3`  |

## Objective



This job will allow you to migrate the database using a migration file that you already have in `database/migrations`, and it provides an artifact with all the logs at the end
@@ -27,7 +26,7 @@ This job will allow you to migrate the database using a migration file that you 
| `ENV_NAME` | `.env.testing` | Name of the environment variables file to use |

| `ARTISAN_MIGRATE_OPTIONS` | ` ` | Options for command `php artisan migrate` |

| `ARTISAN_OUTPUT` | `artisan_migration.log` | Name for logs file |



| `IMAGE_TAG` | The default tag for the docker image | `7.3`  |



## Artifacts

jobs/docker_build/README.md

+2 −2
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ The registry and tag of the resulting Docker image follow this behavior: 
!!! info

    In order to use custom registries, you need to provide the file `config.json` that contains the auths, you can do that by passing it as a [CI/CD file](https://docs.gitlab.com/ee/ci/variables/#cicd-variable-types){:target="_blank"} named `CONFIG_FILE` (see example below)



### Variables

## Variables



| Name | Description | Default |

| ---- | ----------- | ------- |
@@ -81,5 +81,5 @@ The registry and tag of the resulting Docker image follow this behavior: 






### Author

## Author

This resource is an **[official job](https://docs.r2devops.io/faq-labels/)** added in [**R2Devops repository**](https://gitlab.com/r2devops/hub) by [@thomasboni](https://gitlab.com/thomasboni)
 
 No newline at end of file

jobs/dotnet_build/README.md

+4 −4
Original line number Diff line number Diff line 
| `IMAGE_TAG` | The default tag for the docker image | `3.12.1`  |

## Objective



Builds a .NET Core project with the different versions available, and makes it ready to run.
@@ -15,9 +14,9 @@ It is using the scripted installation provided from Microsoft, see [here](https: 


## Variables



| VARIABLE NAME | DESCRIPTION | DEFAULT VALUE |

|:-|:-|:-

| `DOTNET_OUTPUT` <img width=230/> | Path to the output build (used as artifact) <img width=175/>| `/build` <img width=100/>|

| Name | Description | Default |

| ---- | ----------- | ------- |

| `DOTNET_OUTPUT` <img width=100/> | Path to the output build (used as artifact) <img width=175/>| `/build` <img width=100/>|

| `DOTNET_VERSION` | .NET version used to build. You have the choice between multiples versions (see [versions](https://github.com/dotnet/installer#installers-and-binaries){:target="_blank"}). | `3.1` |

| `DOTNET_VERBOSITY` | Prints more or less logs (*Types available*: `q[uiet]`, `m[inimal]`, `n[ormal]`, `d[etailed]` and `diag[nostic]`) | `m` |

| `DOTNET_CONFIG` | Configuration profile used to build | `Debug` |
@@ -27,6 +26,7 @@ It is using the scripted installation provided from Microsoft, see [here](https: 
| `DOTNET_SELF_CONTAINED` | Publish the .NET Core runtime along with the build | `false`

| `DOTNET_OPTIONS` | Additional options from user | ` `

| `PROJECT_ROOT` | The location of the .NET project in your repository | `/` |

| `IMAGE_TAG` | The default tag for the docker image | `3.12.1`  |



!!! warning

    Since **version 5.0** of .NET is still in **release-candidate** at this time, the format of `DOTNET_VERSION` is slightly different from just `3.1` or `2.1`. See [Microsoft documentation](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-install-script#options){:target="_blank"} (*argument `-Channel`*) to see how to specify this new version.

jobs/doxygen/README.md

+15 −15
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ Other languages can be supported with additional code. 


| Name | Description | Default |

| ---- | ----------- | ------- |

| `INPUT` <img width=650px>               | Input directory of your source files <img width=125>| `.` <img width=300>|

| `INPUT` <img width=100> | Input directory of your source files <img width=175> | `.` <img width=100> |

| `DOXYGEN_CONFIGFILE` | Name of your Doxygen configuration file| `Doxyfile`|

| `DOXYGEN_PROJECT_NAME` | Name of your Doxygen project, for the documentation title| `$CI_PROJECT_NAME`  (Gitlab project name) |

| `DOXYGEN_INPUT` | The path to your documented source files| `.`|