From 305fddcd369bfc55b7beac8e9ba96b2389d5ef96 Mon Sep 17 00:00:00 2001 From: RobertoChiosa Date: Tue, 13 Aug 2024 15:09:39 +0200 Subject: [PATCH] docs(readme): added action to create release --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++ .github/workflows/release.yml | 27 ++++++++++++++++++++ RELEASE.md | 3 +++ pyproject.toml | 2 +- 5 files changed, 81 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/release.yml create mode 100644 RELEASE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..498c59a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behaviour** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Hardware (please complete the following information):** + +- OS and version: [e.g. iOS 10.7 or Windows 10] +- Version of CEA you are using [e.g. v. 2.31.1] \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..e555298 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Describe the feature you would like to have** +Ex. I would like to have [...] + +**Describe the end purpose of this feature** +Ex. So I could visualize/understand/know/apply etc.. + +**Describe the end-user of this feature** +Ex. A Researcher, a Student, or a Practitioner. + +**Provide Additional information if possible** +EX. Screenshots, Links, Methods \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..7c442b2 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,27 @@ +name: Build and Release + +on: + # should work + workflow_dispatch: + push: + tags: + - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 + +jobs: + release: + name: "Create Development Release" + runs-on: ubuntu-latest + steps: + - name: "Clone repository" + uses: actions/checkout@v4 + - name: "Create Release" + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ github.ref }} + release_name: Release ${{ github.ref }} + body_path: RELEASE.md + draft: false + prerelease: false diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..a8148e6 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,3 @@ +### Features: + +- Added command line interface for the tool \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 2575ccc..fc242b3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "cmp" -version = "0.1.0" +version = "0.1.1" description = "" authors = ["RobertoChiosa "] readme = "README.md"