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

Merge branch '54-add-issue-and-mr-templates' into 'main' 

Resolve "Add issue and MR templates"

Closes #54

See merge request to-be-continuous/defectdojo!88
parents 2e2bd19a 9d49b2de

.gitlab/issue_templates/bug_report.md

0 → 100644
+53 −0
Original line number Diff line number Diff line 
## Describe the bug



(Describe the problem clearly and concisely.)





## Expected behavior



(Describe the expected behavior clearly and concisely.)





## Actual behavior



(Describe the actual behavior clearly and concisely.)





## Logs and/or screenshots



(Join any relevant logs and/or screenshot. Please use code blocks (```) to format console output, logs, and code.)





## Context & Configuration



Link to a project, pipeline or job facing the bug: (please provide one if possible)



The issue was reproduced using:



* Version of the template: (type in the version)

* GitLab server(s): (Was it gitlab.com? A self-managed server? Which version? CE / EE? Which license?)

* GitLab runner(s): (type in any relevant information about the GitLab runner(s) you used)





Here is the `.gitlab-ci.yml` file:



```yaml

# Add your .gitlab-ci.yml here, if applicable and useful.



```



(If useful, list configured GitLab CI project and/or group variables.)



Configured GitLab CI project or group variables:



* `VARIABLE_1`

* `VARIABLE_2`

* ...





(Finally add any possible additional useful context info here.)









/label ~"kind/bug" ~"status/needs-investigation"

.gitlab/issue_templates/feature_request.md

0 → 100644
+11 −0
Original line number Diff line number Diff line 
## Description



(Describe the feature clearly and concisely.)



## Implementation ideas



(If you have any implementation ideas, they can go here.)

(Any design change proposal could be also discussed on the _to be continuous_ Discord server.)





/label ~"kind/enhancement" ~"status/needs-investigation"

.gitlab/merge_request_templates/bug_fix.md

0 → 100644
+15 −0
Original line number Diff line number Diff line 
## Presentation



(Necessarily link to an issue. If it doesn't exist, please create one.)



Fixes #999



## Checklist



* Documented:

    * [ ] `README.md` reflects any job, variable or whichever visible change

    * [ ] `kicker.json` reflects any job, variable or whichever visible change

* Tested & examplified:

    * [ ] (url to a project sample successfully proving the merge request fixes the issue)



/label ~"kind/fix"

.gitlab/merge_request_templates/initial.md

0 → 100644
+125 −0
Original line number Diff line number Diff line 
## Presentation



(Select the type of template hereafter.)



Template type: **build** / **analyse** / **package** / **deploy** / **acceptance** / others ?



(Describe here the goal and context of this template.)





## Checklist



* General:

    * [ ] add project logo (`logo.png` file) - preferably 256x256

    * [ ] defines a base (hidden) job

    * [ ] use [rules](https://docs.gitlab.com/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ci/yaml/#onlyexcept-advanced)

    * [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration (wherever applicable)

* Publicly usable:

    * [ ] runners: untagged

    * [ ] no proxy configuration but support `http_proxy`/`https_proxy`/`no_proxy` configuration 

    * [ ] no custom CA certificate(s) but supports `$CUSTOM_CA_CERTS` or `$DEFAULT_CA_CERTS` to declare custom CA certificate(s)

    * [ ] internet hostnames/urls only

* Used Docker images:

    * [ ] **public** images

    * [ ] **official** images (when possible)

    * [ ] `latest` tag (when possible)

* Documented:

    * [ ] `README.md` presents the template, jobs, tools, variables and variants

    * [ ] `kicker.json` describes the template, jobs, tools, variables and variants

* Tested & examplified:

    * [ ] (url to a project sample successfully using this template)

    * [ ] (maybe another one with a different context)

    * ...



### Build & Test template checklist



(Remove this chapter if not applicable to your template type.)



* Build & Test job:

    * (type here the used build & test tools/frameworks)

    * [ ] mapped to the `build` stage

    * [ ] unit tests report integration using [JUnit test report](https://docs.gitlab.com/ci/testing/unit_test_reports/)

    * [ ] code coverage computing and [integration](https://docs.gitlab.com/ci/yaml/#coverage)

    * [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration

* (optional) Code analysis job(s):

    * (type here the used code analysis tools)

    * [ ] mapped to the `test` stage

    * [ ] can be enabled/disabled by configuration

* (optional) Publish job:

    * (type here the used publish tools)

    * [ ] mapped to the `publish` stage

    * [ ] can be enabled by configuration

    * [ ] manually triggered on `master` branch



### Code Analysis template checklist



(Remove this chapter if not applicable to your template type.)



* Code analysis job:

    * [ ] mapped to the `test` stage

    * [ ] can be enabled/disabled by configuration

    * [ ] whenever possible, code analysis on non-`master`, non-`develop` branches should be a partial/light analysis

    * [ ] if the analysis is time consuming it shall be [triggered manually](https://docs.gitlab.com/ci/yaml/#whenmanual)

      by default, and automatable by configuration



### Packaging template checklist



(Remove this chapter if not applicable to your template type.)



* [ ] Build job mapped to the `package-build` stage that build the package

* [ ] (optional) Code Analysis job(s) (lint, dependency check, ...) on the packaging descriptors and scripts

  mapped to the `build` or `test` stage

* [ ] (optional) Test job(s) mapped to the `package-test` stage that test and analyse the built package

* [ ] Publish job mapped to the `publish` stage that publishes the built package to a compatible package repository



### Deploy & Run template checklist



(Remove this chapter if not applicable to your template type.)



* Deployment jobs:

    * [ ] one hidden deploy job prototype

    * [ ] persist and propagate the `$CI_ENVIRONMENT_URL` variable as `environment_url` variable using a 

      [dotenv artifact](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsdotenv)

    * [ ] each env can be enabled/disabled by configuration

    * [ ] each env uses the [`resource_group`](https://docs.gitlab.com/ci/yaml/#resource_group) feature to prevent 

      multiple pipelines from deploying to the same environment at the same time

    * [ ] **review** deployment job

        * mapped to the `deploy` stage

        * must be executed on non-`master`, non-`develop` branches only

        * must reference the **cleanup-review** job (see below) in its [`environment:on_stop`](https://docs.gitlab.com/ci/yaml/#environmenton_stop)

    * [ ] **integration** deployment job

        * mapped to the `deploy` stage

        * must be executed on `develop` branch only

    * [ ] **staging** deployment job

        * mapped to the `deploy` stage

        * must be executed on `master` branch only

    * [ ] **production** deployment job

        * mapped to the `production` stage

        * must be executed on `master` branch only

* Cleanup jobs

    * [ ] one hidden cleanup job prototype

    * [ ] **review** cleanup job

        * mapped to the `deploy` stage

        * must be executed on non-`master`, non-`develop` branches only

        * must be associated to the [`environment:action:stop`](https://docs.gitlab.com/ci/yaml/#environmentaction) event

* (optional) Analysis job(s) (linters, dependency checks, ...) depending on the technologies:

    * [ ] mapped to the `test` stage



### Acceptance template checklist



(Remove this chapter if not applicable to your template type.)



* Acceptance test job:

    * [ ] mapped to the `acceptance` stage

    * [ ] tests report integration using [JUnit test report](https://docs.gitlab.com/ci/testing/unit_test_reports/)

    * [ ] auto-evaluating the environment url to test based on the possible upstream `$environment_url` variable or via 

      an `environment_url.txt` file.





## Contribution resources



Don't hesitate to review general [workflow rules](https://to-be-continuous.gitlab.io/doc/dev/workflow/)

and [coding guidelines](https://to-be-continuous.gitlab.io/doc/dev/guidelines/) for your contribution.





/label ~"kind/new-template"

.gitlab/merge_request_templates/new_feature.md

0 → 100644
+29 −0
Original line number Diff line number Diff line 
## Presentation



(Necessarily link to an issue. If it doesn't exist, please create one.)



Closes #999





## Checklist



* General:

    * [ ] use [rules](https://docs.gitlab.com/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ci/yaml/#onlyexcept-advanced)

    * [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration (wherever applicable)

* Publicly usable:

    * [ ] untagged runners

    * [ ] no proxy configuration but support `http_proxy`/`https_proxy`/`no_proxy`

    * [ ] no custom CA certificate(s) but supports `$CUSTOM_CA_CERTS` or `$DEFAULT_CA_CERTS` to declare custom CA certificate(s)

    * [ ] internet hostnames/urls only

* Used Docker images:

    * [ ] **public** images

    * [ ] **official** images (when possible)

    * [ ] `latest` tag (when possible)

* Documented:

    * [ ] `README.md` documents the new feature

    * [ ] `kicker.json` describes the new feature

* Tested & examplified:

    * [ ] (url to a project sample successfully using the new feature)





/label ~"kind/enhancement"