Commit fb074a95 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

refactor: rename template base name

parent aa20fede

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ stages: 
  - publish



variables:

  GITLAB_CI_FILES: "templates/gitlab-ci-usebruno.yml"

  GITLAB_CI_FILES: "templates/gitlab-ci-bruno.yml"

  BASH_SHELLCHECK_FILES: "*.sh"



semantic-release:

Bruno.r2.yml

+2 −2
Original line number Diff line number Diff line 
files:

    template: ./templates/gitlab-ci-usebruno.yml

    template: ./templates/gitlab-ci-bruno.yml

    documentation: ./README.md

    changelog: ./CHANGELOG.md

data:

    description: "Run your automated tests with Bruno"

    description: "Run your automated API tests with Bruno"

    labels:

    - to be continuous

    - Test

CONTRIBUTING.md

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ We try to make it easy, and all contributions, even the smaller ones, are more t 
This includes bug reports, fixes, documentation, examples...

But first, read this page (including the small print at the end).



Contributions are available on https://gitlab.com/to-be-continuous/usebruno.

Contributions are available on https://gitlab.com/to-be-continuous/bruno.



## Legal

README.md

+7 −6
Original line number Diff line number Diff line 
# GitLab CI template for Bruno

This project implements a GitLab CI/CD template to run your automated tests with [Bruno](https://www.usebruno.com/).



This project implements a GitLab CI/CD template to run your automated API tests with [Bruno](https://www.usebruno.com/).



## Usage
@@ -7,12 +8,12 @@ In order to include this template in your project, add the following to your `gi 


```yaml

include:

  - project: 'to-be-continuous/usebruno'

  - project: 'to-be-continuous/bruno'

    ref: '1.0.0'

    file: '/templates/gitlab-ci-usebruno.yml'

    file: '/templates/gitlab-ci-bruno.yml'

```



## `usebruno` job

## `bruno` job



This job starts [Bruno](https://www.usebruno.com/) (functional) tests.
@@ -20,7 +21,7 @@ It uses the following variable: 


| Name                  | Description                              | Default value     |

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

| `BRU_IMAGE`       | The Docker image used to run Bruno. | `registry.hub.docker.com/usebruno:latest` |

| `BRU_IMAGE`       | The Docker image used to run Bruno. | `registry.hub.docker.com/bruno:latest` |

| `BRU_PROJECT_DIR` | The Bruno project directory (containing test scripts) | `.` |

| `BRU_EXTRA_ARGS`  | Bruno extra [run options](link-to-cli-options-ref) | _none_ |

| `REVIEW_ENABLED`      | Set to `true` to enable Bruno tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled) |
@@ -29,7 +30,7 @@ In addition to a textual report in the console, this job produces the following 


| Report         | Format                                                                       | Usage             |

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

| `$BRU_PROJECT_DIR/reports/usebruno.xunit.xml` | [xUnit](https://github.com/jest-community/jest-junit#readme) test report(s) | [GitLab integration](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsjunit) |

| `$BRU_PROJECT_DIR/reports/bruno.xunit.xml` | [xUnit](https://github.com/jest-community/jest-junit#readme) test report(s) | [GitLab integration](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsjunit) |



### base url auto evaluation

SECURITY.md

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ Security fixes and updates are only applied to the latest released version. So a 
## Reporting a Vulnerability



In order to minimize risks of attack while investigating and fixing the issue, any vulnerability shall be reported by 

opening a [**confidential** issue on gitlab.com](https://gitlab.com/to-be-continuous/usebruno/-/issues/new?issue[confidential]=true&issue[description]=%28type+in+the+vulnerability+details+here%29%0A%0A%2Flabel%20~%22kind%3A%3Avulnerability%22).

opening a [**confidential** issue on gitlab.com](https://gitlab.com/to-be-continuous/bruno/-/issues/new?issue[confidential]=true&issue[description]=%28type+in+the+vulnerability+details+here%29%0A%0A%2Flabel%20~%22kind%3A%3Avulnerability%22).



Follow-up and fixing will be made on a _best effort_ basis.