From 0e51d7593d7a3704a4231bc5a24439ed094e4431 Mon Sep 17 00:00:00 2001 From: STAM Date: Sat, 2 Nov 2024 22:41:00 +0300 Subject: [PATCH] meta improvemetns * added changelog --- .github/ISSUE_TEMPLATE/template-bug.yml | 132 +++++++++++++++++++ .github/ISSUE_TEMPLATE/template-cve.yml | 39 ++++++ .github/ISSUE_TEMPLATE/template-feature.yml | 31 +++++ .github/ISSUE_TEMPLATE/template-question.yml | 28 ++++ .github/ISSUE_TEMPLATE/template-task.yml | 28 ++++ .github/pull_request_template.md | 13 ++ .github/workflows/sync-with-gitlab.yml | 31 +++++ CHANGELOG.md | 109 +++++++++++++++ LICENSE => LICENSE.md | 0 SECURITY.md | 7 + 10 files changed, 418 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/template-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/template-cve.yml create mode 100644 .github/ISSUE_TEMPLATE/template-feature.yml create mode 100644 .github/ISSUE_TEMPLATE/template-question.yml create mode 100644 .github/ISSUE_TEMPLATE/template-task.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/sync-with-gitlab.yml create mode 100644 CHANGELOG.md rename LICENSE => LICENSE.md (100%) create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/template-bug.yml b/.github/ISSUE_TEMPLATE/template-bug.yml new file mode 100644 index 000000000..bba55a606 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-bug.yml @@ -0,0 +1,132 @@ +name: Bug Report +description: A generic bug report +title: "[BUG]: " +#labels: ["Type: Bug", "Status: Available"] +#assignees: +# - s1lentq +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details (optional) + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: A bug happened! + validations: + required: true + - type: dropdown + id: mmrversion + attributes: + label: Metamod-r Version + description: What version of Metamod-r are you running? + options: + - I am not use metamod-r + - 1.3.0.149 (Default) + - 1.3.0.138 + - 1.3.0.131 + - 1.3.0.128 + - 1.3.0.126 + - 1.3.0.125 + - 1.3.0.119 + - 1.3.0.107 + - 1.3.0.86 + - 1.3.0.85 + - 1.3.0.84 + default: 0 + validations: + required: true + - type: dropdown + id: amxxversion + attributes: + label: AMX Mod X Version + description: What version of AMX Mod X are you running? + options: + - 1.8.2 (Default) + - 1.9.x + - 1.10.x + - I am not use AMX Mod X + default: 0 + validations: + required: true + - type: dropdown + id: enginever + attributes: + label: What version of engine are you seeing the problem on? + multiple: true + options: + - reHLDS (Nightly CI build) + - reHLDS (3.13.0.788) + - reHLDS (3.12.0.780) + - reHLDS (3.11.0.779) + - reHLDS (3.11.0.777) + - reHLDS (3.11.0.776) + - reHLDS (3.11.0.767) + - reHLDS (3.10.0.761) + - reHLDS (3.10.0.760) + - reHLDS (3.10.0.760-dev) + - reHLDS (3.10.0.759) + - reHLDS (3.9.0.752) + - reHLDS (3.8.0.739) + - reHLDS (3.8.0.723) + - reHLDS (3.8.0.715) + - reHLDS (3.8.0.711) + - reHLDS (3.8.0.702) + - reHLDS (3.7.0.698) + - reHLDS (3.7.0.697) + - reHLDS (3.7.0.696) + - reHLDS (3.7.0.695) + - reHLDS (3.7.0.694) + validations: + required: true + - type: dropdown + id: os + attributes: + label: What OS are you seeing the problem on? + multiple: true + options: + - Windows + - Linux + validations: + required: true + - type: dropdown + id: osver + attributes: + label: What OS version are you seeing the problem on? + multiple: true + options: + - Windows 7 + - Windows 8 + - Windows 8.1 + - Windows 10 + - Windows 11 + - Ubuntu 14.x + - Ubuntu 16.x + - Ubuntu 18.x + - Ubuntu 20.x + - Ubuntu 22.x + - Debian 10 + - Debian 11 + - Debian 12 + - Other Linux + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: markdown + attributes: + value: Thanks for completing our form! diff --git a/.github/ISSUE_TEMPLATE/template-cve.yml b/.github/ISSUE_TEMPLATE/template-cve.yml new file mode 100644 index 000000000..a79124ec7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-cve.yml @@ -0,0 +1,39 @@ +name: CVE report +description: Create a report of some CVE +title: "[CVE]: " +#labels: ["Engine: Independent", "Priority: Medium", "OS: Independent", "Status: Available", "Type: Rrequest"] +#assignees: +# - s1lentq +# - stamepicmorg +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this Feature request! + - type: input + id: contact-task + attributes: + label: Contact Details (optional) + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: input + id: cvce-id + attributes: + label: CVE number or URL + description: Please place here CVE number or provide url with info. + placeholder: CVE-123456 https://localhost + validations: + required: false + - type: textarea + id: have-idea + attributes: + label: Tell us more about CVE + description: A clear and concise description of what the CVE is. + placeholder: If applicable, add screenshots to help explain your problem. + value: There is CVE description... + validations: + required: true + - type: markdown + attributes: + value: Thanks for completing our form! diff --git a/.github/ISSUE_TEMPLATE/template-feature.yml b/.github/ISSUE_TEMPLATE/template-feature.yml new file mode 100644 index 000000000..e5c3456ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-feature.yml @@ -0,0 +1,31 @@ +name: New Feature +description: Suggest an idea for this project +title: "[Feature request]: " +#labels: ["Engine: Independent", "Priority: Medium", "OS: Independent", "Status: Available", "Type: Rrequest"] +#assignees: +# - s1lentq +# - stamepicmorg +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this Feature request! + - type: input + id: contact-task + attributes: + label: Contact Details (optional) + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: have-idea + attributes: + label: Tell us more about your idea + description: Tell us what you expect from the project and the developers? + placeholder: Tell us about your idea! + value: I have an idea! + validations: + required: true + - type: markdown + attributes: + value: Thanks for completing our form! diff --git a/.github/ISSUE_TEMPLATE/template-question.yml b/.github/ISSUE_TEMPLATE/template-question.yml new file mode 100644 index 000000000..695e81b07 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-question.yml @@ -0,0 +1,28 @@ +name: Question +description: Create some Question for this project +title: "[Question]: " +#labels: ["Engine: Independent", "Priority: Medium", "OS: Independent", "Status: Available", "Type: Question"] +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this Question! + - type: input + id: contact + attributes: + label: Contact Details (optional) + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: have-question + attributes: + label: Tell us more about your Question + description: What happened? + placeholder: Tell us about your Question! + value: I have an Question! + validations: + required: true + - type: markdown + attributes: + value: Thanks for completing our form! diff --git a/.github/ISSUE_TEMPLATE/template-task.yml b/.github/ISSUE_TEMPLATE/template-task.yml new file mode 100644 index 000000000..2d5e495e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-task.yml @@ -0,0 +1,28 @@ +name: Task +description: Create some generic task for this project +title: "[TASK]: " +#labels: ["Engine: Independent", "Priority: Medium", "OS: Independent", "Status: Available", "Type: Task"] +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this Task! + - type: input + id: contact-feature + attributes: + label: Contact Details (optional) + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: have-task + attributes: + label: Tell us more about your task + description: Tell us what you want from the project and the developers? + placeholder: Tell us about your task! + value: I have an task! + validations: + required: true + - type: markdown + attributes: + value: Thanks for completing our form! diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..c7f800734 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,13 @@ +## Purpose +_Describe the problem or feature in addition to a link to the issues._ + +## Approach +_How does this change address the problem?_ + +#### Open Questions and Pre-Merge TODOs +- [ ] Use github checklists. When solved, check the box and explain the answer. + +## Learning +_Describe the research stage_ + +_Links to blog posts, patterns, libraries or addons used to solve this problem_ diff --git a/.github/workflows/sync-with-gitlab.yml b/.github/workflows/sync-with-gitlab.yml new file mode 100644 index 000000000..15cc4a94b --- /dev/null +++ b/.github/workflows/sync-with-gitlab.yml @@ -0,0 +1,31 @@ +name: Automatic sync with Gitlab's read-only mirror + +on: [workflow_dispatch, push] + +jobs: + mirror: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up SSH key for Runner + env: + SSH_KEY: ${{ secrets.GITLAB_DEPLOY_KEY }} + run: | + mkdir -p ~/.ssh + echo "$SSH_KEY" > ~/.ssh/id_ed25519 + chmod 600 ~/.ssh/id_ed25519 + ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts + ssh-keyscan -t rsa gitlab.com >> ~/.ssh/known_hosts + + - name: Clone repository from GitHub as mirror and push to Gitlab + env: + REPO_ORIGINAL: "https://github.com/rehlds/.github.git" + REPO_TARGET: "git@gitlab.com:rehlds/dot-github.git" + run: | + git clone --mirror "$REPO_ORIGINAL" repo-mirror + cd repo-mirror + git remote set-url origin "$REPO_TARGET" + git push --mirror --force diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..c402a9752 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,109 @@ +# [reHLDS](https://github.com/rehlds/rehlds) Changelog + +**ReHLDS** is a result of reverse engineering of original `HLDS` (build `6152`/`6153`) using `DWARF` debug info embedded into linux version of `HLDS`, `engine_i486.so`. + +Along with reverse engineering, a lot of defects and (potential) bugs were found and fixed. + +--- + +## [`3.8.0.739`](https://github.com/rehlds/rehlds/releases/tag/3.8.0.739) - 2021-04-21 + +### Added +* Added libraries libm/librt built on `GLIBC` `2.11.1` #827 + +### Fixed +* `QuaternionSlerp`: Fixed wrong values #763 + +### Changed +* Updated `Intel C++ Compiler` version `17.0` up to `19.0` + +**Full Changelog**: [3.8.0.723...3.8.0.739](https://github.com/rehlds/rehlds/compare/3.8.0.723...3.8.0.739) + +## [`3.8.0.723`](https://github.com/rehlds/rehlds/releases/tag/3.8.0.723) - 2021-03-23 + +### Fixed +* `CalcSurfaceExtents:` Fixed a fatal error on some maps due loss of floating point +* `HLTV:` ExecuteString Fix parser #821 + +### Changed +* `HLTV:` Downgrade GLIBC version + +**Full Changelog**: [3.8.0.715...3.8.0.723](https://github.com/rehlds/rehlds/compare/3.8.0.715...3.8.0.723) + +## [`3.8.0.715`](https://github.com/rehlds/rehlds/releases/tag/3.8.0.715) - 2021-03-18 + +### Fixed +* Make sure the `timer` is high precision #799 + +**Full Changelog**: [3.8.0.711...3.8.0.715](https://github.com/rehlds/rehlds/compare/3.8.0.711...3.8.0.715) + +## [`3.8.0.711`](https://github.com/rehlds/rehlds/releases/tag/3.8.0.711) - 2021-02-06 + +### Added +* `HLTV`: Added new chatdelay command #777 +* `HLTV`: prevent clients from setting userinfo * keys with setinfo command #792 +* `Cbuf_Execute`: Add checks commented out for multi-lines #719 + +### Fixed +* Fixed local-buffer overrun, may undefined behavior with hitboxes blending or crash (reverse-engineering mistake) 722e19d +* Fixed dos attack on connection challenges system #802 +* Fixed crash `COM_ListMaps` #791 + +**Full Changelog**: [3.8.0.702...3.8.0.711](https://github.com/rehlds/rehlds/compare/3.8.0.702...3.8.0.711) + +## [`3.8.0.702`](https://github.com/rehlds/rehlds/releases/tag/3.8.0.702) - 2020-11-09 + +### Fixed +* Fixed crash `MSG_ReadFloat` + +### Changed +* **ReHLDS API:** Implemented `SV_ShouldSendConsistencyList` +* **ReHLDS API:** Bump minor + +**Full Changelog**: [3.7.0.698...3.8.0.702](https://github.com/rehlds/rehlds/compare/3.7.0.698...3.8.0.702) + +## [`3.7.0.698`](https://github.com/rehlds/rehlds/releases/tag/3.7.0.698) - 2020-08-19 + +### Added +* Graceful shutdown on sigterm (#776) + - Add players kick on `SIGINT \ SIGTERM` + - Add SIGINT & SIGTERM handling linux console + +### Changed +* Changed shutdown method + +**Full Changelog**: [3.7.0.697...3.7.0.698](https://github.com/rehlds/rehlds/compare/3.7.0.697...3.7.0.698) + +## [`3.7.0.697`](https://github.com/rehlds/rehlds/releases/tag/3.7.0.697) - 2020-08-10 + +### Fixed +* **SV_ProcessFile:** Wrap `Con_Printf` in `Con_NetPrintf` to avoid spam in HLDS console + +**Full Changelog**: [3.7.0.696...3.7.0.697](https://github.com/rehlds/rehlds/compare/3.7.0.696...3.7.0.697) + +## [`3.7.0.696`](https://github.com/rehlds/rehlds/releases/tag/3.7.0.696) - 2020-05-18 + +### Added +* Implement `svc_exec` support in the engine and HLTV (#737) + - Added `svc_exec` to the list of svc commands in engine + - Added `svc_exec` support to HLTV code + - Made the engine code forward-compatible with future svc_* additions + - Added reserved svc_* slots in the enumerations + +**Full Changelog**: [3.7.0.695...3.7.0.696](https://github.com/rehlds/rehlds/compare/3.7.0.695...3.7.0.696) + +## [`3.7.0.695`](https://github.com/rehlds/rehlds/releases/tag/3.7.0.695) - 2020-04-06 + +### Fixed +* Vulnerability fix WAD part 2 + - Client-side: Fixed a potential vulnerability from bogus `tempdecal.wad` + +**Full Changelog**: [3.7.0.694...3.7.0.695](https://github.com/rehlds/rehlds/compare/3.7.0.694...3.7.0.695) + +## [`3.7.0.694`](https://github.com/rehlds/rehlds/releases/tag/3.7.0.694) - 2020-03-20 + +### Fixed +* Vulnerability fix WAD part 1 + - Server-side: Fixed a potential vulnerability from bogus `tempdecal.wad` + +**Full Changelog**: [3.7.0.694](https://github.com/rehlds/rehlds/commits/3.7.0.694) diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..1d1d43c0d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security Policy + +## Reporting a Vulnerability +1. Open `Issues` tab [here](https://github.com/rehlds/rehlds/issues). +2. Select `CVE Report`. +3. Publish `CVE Report`. +4. Thank you :heart: