From b62138c10945464bfc4d60e32f760debfb7f41ce Mon Sep 17 00:00:00 2001 From: Veronica Valeros Date: Fri, 19 Apr 2024 13:42:21 +0200 Subject: [PATCH] Prepare repository for LTS support (#4) * Create SECURITY.md * Create pull_request_template.md * Rename SECURITY.md to .github/SECURITY.md * Rename CODE_OF_CONDUCT.md to .github/CODE_OF_CONDUCT.md * Create bug_report.md * Create feature_request.md * Create autotag.yml --- .../CODE_OF_CONDUCT.md | 0 .github/ISSUE_TEMPLATE/bug_report.md | 18 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 ++++++++++ .github/SECURITY.md | 13 +++++++ .github/pull_request_template.md | 29 +++++++++++++++ .github/workflows/autotag.yml | 36 +++++++++++++++++++ 6 files changed, 114 insertions(+) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (100%) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/SECURITY.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/autotag.yml diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..c830d73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,18 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behaviour if applicable. Be brief but make sure it can be reproduced. Bullet points are welcomed here. + +**Expected behaviour** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..835cc93 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEAT]" +labels: enhancement +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..47a2653 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,13 @@ +# Security Policy + +## Reporting a Vulnerability + +Report security vulnerabilities to stratosphere+numberanomalydetector@aic.fel.cvut.cz. We are a small team. We will acknowledge your email as soon as we can. Report security vulnerabilities in third-party modules to the person or +team maintaining the module. + +## Disclosure Policy + +When our team receives a security bug report, we will take the following steps: + + * Confirm the problem and determine the impact. + * Prepare a fix to the latest current version. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..48af794 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ + +# Description + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Describe test +- [ ] Describe test + + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings diff --git a/.github/workflows/autotag.yml b/.github/workflows/autotag.yml new file mode 100644 index 0000000..a5bdb56 --- /dev/null +++ b/.github/workflows/autotag.yml @@ -0,0 +1,36 @@ +name: Auto Tag +on: + push: + branches: + - main +jobs: + Patch: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - name: Minor version for each merge + id: taggerDryRun + uses: anothrNick/github-tag-action@1.36.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + WITH_V: true + DRY_RUN: true + + - name: echo new tag + run: | + echo "The next tag version will be: ${{ steps.taggerDryRun.outputs.new_tag }}" + - name: echo tag + run: | + echo "The current tag is: ${{ steps.taggerDryRun.outputs.tag }}" + - name: echo part + run: | + echo "The version increment was: ${{ steps.taggerDryRun.outputs.part }}" + + - name: Minor version for each merge + id: taggerFinal + uses: anothrNick/github-tag-action@1.36.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + WITH_V: true