SECURITY.md (#179)

* doc : SECURITY.md added

* doc : RELEASE.md updated

* doc : RELEASE.md updated

* doc : CHANGELOG.md updated

* fix : windows version fixed

* fix : version_check.py updated

* doc : badges bug fixed

* fix : SECURITY.md version fixed

* doc : AUTHORS.md updated

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-20.04,windows-latest]
+        os: [ubuntu-20.04, windows-2022]
         python-version: [3.6, 3.7, 3.8, 3.9, 3.10.0, 3.11.0, 3.12.0]
     env:
       DISPLAY: :99.0

AUTHORS.md

@@ -1,4 +1,4 @@
-# Core Developers #
+# Core Developers
 
 ----------
 - Mohammad Mahdi Rahimi - ECSIM - ([GitHub](https://github.com/mahi97))
@@ -9,7 +9,7 @@
 ** **Maintainer**
 
 
-# Other Contributors #
+# Other Contributors
 
 ----------
 - [Sadra Sabouri](https://github.com/sadrasabouri)

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- `SECURITY.md`
 ### Changed
 - `README.md` modified
 - Logo updated

README.md

@@ -1,15 +1,9 @@
 <div align="center">
 	<img src="https://github.com/ECSIM/gopem/raw/master/rsrc/logo.png" width=320px>
 	<br>
-	<a href="https://www.python.org/">
-		<img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3">
-	</a>
-	<a href="https://badge.fury.io/py/gopem">
-		<img src="https://badge.fury.io/py/gopem.svg" alt="PyPI version" height="18">
-	</a>
-	<a href="https://discord.gg/mgpwvEuBxZ">
-		<img src="https://img.shields.io/discord/1006472275920425012.svg" alt="Discord Channel">
-	</a>
+	<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
+	<a href="https://badge.fury.io/py/gopem"><img src="https://badge.fury.io/py/gopem.svg" alt="PyPI version" height="18"></a>
+	<a href="https://discord.gg/mgpwvEuBxZ"><img src="https://img.shields.io/discord/1006472275920425012.svg" alt="Discord Channel"></a>
 </div>
 
 --------

SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+| Version       | Supported          |
+| ------------- | ------------------ |
+| 0.8           | :white_check_mark: |
+| < 0.8         | :x:                |
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities by email to [opem@ecsim.site](mailto:opem@ecsim.site "opem@ecsim.site").
+
+If the security vulnerability is accepted, a dedicated bugfix release will be issued as soon as possible (depending on the complexity of the fix).

rsrc/RELEASE.md

@@ -1,16 +1,17 @@
 # GOPEM Release Instructions
 
-#### Last Update: 2024-04-02
+**Last Update: 2024-05-07**
 
 1. Create the `release` branch under `develop`
 2. Update all version tags
 	1. `setup.py`
 	2. `README.md`
-	3. `GOPEM.spec`
-	4. `GOPEM.iss`
-	5. `gopem/helper.py`
-	6. `rsrc/version_check.py`
-	7. `rsrc/Version.rc`
+	3. `SECURITY.md`
+	4. `GOPEM.spec`
+	5. `GOPEM.iss`
+	6. `gopem/helper.py`
+	7. `rsrc/version_check.py`
+	8. `rsrc/Version.rc`
 3. Update `CHANGELOG.md`
 	1. Add a new header under `Unreleased` section (Example: `## [0.1] - 2022-08-17`)
 	2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/ECSIM/gopem/compare/v0.1...v0.2`)

rsrc/version_check.py

@@ -35,10 +35,12 @@
 INNO_ITEMS = ['#define MyAppVersion "{0}"']
 SPEC_ITEMS = ['gopem_version = "{0}"']
 ISSUE_TEMPLATE_ITEMS = ["- GOPEM {0}"]
+SECURITY_ITEMS = ["| {0}           | :white_check_mark: |", "| < {0}         | :x:                |"]
 FILES = {
     "setup.py": SETUP_ITEMS,
     "README.md": INSTALL_ITEMS,
     "CHANGELOG.md": CHANGELOG_ITEMS,
+    "SECURITY.md": SECURITY_ITEMS,
     os.path.join(
         "gopem",
         "helper.py"): PARAMS_ITEMS,