From 74e0b3f5a3a8efdc61015cffaca0c49d889ee4d4 Mon Sep 17 00:00:00 2001 From: Riegel Date: Wed, 4 Sep 2024 13:45:04 +0200 Subject: [PATCH] Add GitLab templates and changelog --- .gitlab/.gitmessage | 23 +++++++++++ .gitlab/VULNERABILTIY CLASSIFICATION GUIDE.md | 14 +++++++ .gitlab/changelog_config.yml | 38 +++++++++++++++++++ .gitlab/issue_templates/bug_report.md | 27 +++++++++++++ .gitlab/issue_templates/documentation.md | 14 +++++++ .gitlab/issue_templates/feature_request.md | 14 +++++++ .gitlab/issue_templates/user_story.md | 26 +++++++++++++ .../vulnerability_disclosure.md | 28 ++++++++++++++ .gitlab/merge_request_templates/Default.md | 21 ++++++++++ CHANGELOG.md | 36 ++++++++++++++++++ 10 files changed, 241 insertions(+) create mode 100644 .gitlab/.gitmessage create mode 100644 .gitlab/VULNERABILTIY CLASSIFICATION GUIDE.md create mode 100644 .gitlab/changelog_config.yml create mode 100644 .gitlab/issue_templates/bug_report.md create mode 100644 .gitlab/issue_templates/documentation.md create mode 100644 .gitlab/issue_templates/feature_request.md create mode 100644 .gitlab/issue_templates/user_story.md create mode 100644 .gitlab/issue_templates/vulnerability_disclosure.md create mode 100644 .gitlab/merge_request_templates/Default.md create mode 100644 CHANGELOG.md diff --git a/.gitlab/.gitmessage b/.gitlab/.gitmessage new file mode 100644 index 00000000..b9db7232 --- /dev/null +++ b/.gitlab/.gitmessage @@ -0,0 +1,23 @@ +# Title: Summary, imperative, start upper case, don't end with a period +# No more than 50 chars. #### 50 chars is here: # + +# Remember blank line between title and body. + +# Body: Explain *what* and *why* (not *how*). Include task ID (Jira issue). +# Wrap at 72 chars. ################################## which is here: # + + +# At the end: Include Co-authored-by for all contributors. +# Include at least one empty line before it. Format: +# Co-authored-by: name +# +# How to Write a Git Commit Message: +# https://chris.beams.io/posts/git-commit/ +# +# 1. Separate subject from body with a blank line +# 2. Limit the subject line to 50 characters +# 3. Capitalize the subject line +# 4. Do not end the subject line with a period +# 5. Use the imperative mood in the subject line +# 6. Wrap the body at 72 characters +# 7. Use the body to explain what and why vs. how \ No newline at end of file diff --git a/.gitlab/VULNERABILTIY CLASSIFICATION GUIDE.md b/.gitlab/VULNERABILTIY CLASSIFICATION GUIDE.md new file mode 100644 index 00000000..e32bb92a --- /dev/null +++ b/.gitlab/VULNERABILTIY CLASSIFICATION GUIDE.md @@ -0,0 +1,14 @@ +## Classification Score + +Disclosed vulnerabilities are evaluated by using the [Common Vulnerability Scoring System](https://www.first.org/cvss/v4.0/user-guide). + +The calculator can be found [here](https://www.first.org/cvss/calculator/4.0). + + +## Vulnerability Severities + +**Critical:** ~"Vulnerability::Critical" Vulnerabilities with a Score >= 9, or vulnerabilities which enable remote code execution. + +**High:** ~"Vulnerability::High" Vulnerabilities with a Score >= 5. + +**Minor:** ~"Vulnerability::Minor" Vulnerabilities with a Score < 5, or which require physical access to the system. \ No newline at end of file diff --git a/.gitlab/changelog_config.yml b/.gitlab/changelog_config.yml new file mode 100644 index 00000000..f589acdb --- /dev/null +++ b/.gitlab/changelog_config.yml @@ -0,0 +1,38 @@ +--- +# Settings for generating changelogs using the GitLab API. See +# https://docs.gitlab.com/ee/api/repositories.html#generate-changelog-data for +# more information. +categories: + added: Added + fixed: Fixed + changed: Changed + deprecated: Deprecated + removed: Removed + security: Security + performance: Performance + other: Other +template: | + {% if categories %} + {% each categories %} + ### {{ title }} ({% if single_change %}1 change{% else %}{{ count }} changes{% end %}) + + {% each entries %} + - [{{ title }}]({{ commit.web_url }})\ + {% if author.credit %} by {{ author.reference }}{% end %}\ + {% if commit.trailers.MR %}\ + ([merge request]({{ commit.trailers.MR }}))\ + {% else %}\ + {% if merge_request %}\ + ([merge request]({{ merge_request.web_url }}))\ + {% end %}\ + {% end %}\ + {% if commit.trailers.EE %}\ + **GitLab Enterprise Edition**\ + {% end %} + + {% end %} + + {% end %} + {% else %} + No changes. + {% end %} diff --git a/.gitlab/issue_templates/bug_report.md b/.gitlab/issue_templates/bug_report.md new file mode 100644 index 00000000..621c58eb --- /dev/null +++ b/.gitlab/issue_templates/bug_report.md @@ -0,0 +1,27 @@ +## Summary + + + +## Steps to reproduce + + + + +## What is the current bug behavior? + + + +## What is the expected correct behavior? + + + +## Relevant logs and/or screenshots + + + +## Possible cause + + + +/label Bug \ No newline at end of file diff --git a/.gitlab/issue_templates/documentation.md b/.gitlab/issue_templates/documentation.md new file mode 100644 index 00000000..b30eef69 --- /dev/null +++ b/.gitlab/issue_templates/documentation.md @@ -0,0 +1,14 @@ +## Short description + + + +## Content + + + +## Location + + + + +/label Type::Documentation \ No newline at end of file diff --git a/.gitlab/issue_templates/feature_request.md b/.gitlab/issue_templates/feature_request.md new file mode 100644 index 00000000..877fac13 --- /dev/null +++ b/.gitlab/issue_templates/feature_request.md @@ -0,0 +1,14 @@ +## Summary + + + +## What is the function? + + + +## Why is it requested? + + + + +/label Type::Feature Request \ No newline at end of file diff --git a/.gitlab/issue_templates/user_story.md b/.gitlab/issue_templates/user_story.md new file mode 100644 index 00000000..4bb52398 --- /dev/null +++ b/.gitlab/issue_templates/user_story.md @@ -0,0 +1,26 @@ +## Description + + + +**As a:** + +**I want:** + +**So that:** + +## Acceptance Criteria + + + +**Scenario X: Title of scenario** + +--- +**Given** + +**When** + + +**Then** + + +/label Type::Feature Request \ No newline at end of file diff --git a/.gitlab/issue_templates/vulnerability_disclosure.md b/.gitlab/issue_templates/vulnerability_disclosure.md new file mode 100644 index 00000000..4dfbd18b --- /dev/null +++ b/.gitlab/issue_templates/vulnerability_disclosure.md @@ -0,0 +1,28 @@ +## Summary + + + +## Steps to reproduce + + + + +## What is the current bug behavior? + + + +## What is the expected correct behavior? + + + +## Relevant logs and/or screenshots + + + +## Possible cause + + + +/label Type::Bug Vulnerability::Unclassified +/confidential \ No newline at end of file diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md new file mode 100644 index 00000000..72041d14 --- /dev/null +++ b/.gitlab/merge_request_templates/Default.md @@ -0,0 +1,21 @@ + + + +## What does this MR do? + + + + +## Related issues + + + +## Checklist + +- [ ] Commits squashed, following the message-template and containing changelog-trailers +- [ ] MR title and description are up to date, accurate, and descriptive. +- [ ] MR targeting the appropriate branch. +- [ ] Latest Merge Result pipeline is green. + + + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..fd1b8fe4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,36 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + + +## [3.15.0] (2024-09-03) + +### Added (7 changes) + +- Add CityDoctorAutoPro extension. +- Add CityDoctorGUI extension. +- Add CityDoctorHealer extension. +- Add CityDoctorHealerGUI extension. +- Add CityDoctorHealerGenetic extension. +- Add CityDoctorWebService extension. +- Add Documentation for extension modules. + +### Fixed (1 change) + +- Fix false positives for Solid self-intersections. + +### Changed (1 change) + +- Update Maven dependencies: Include JavaFX + +### Security (1 change) + +- Upgrade SnakeYAML to version 2.0 + +## [3.14.0] (2024-03-20) + +Official Release of CityDoctor2 -- GitLab