Skip to content

Commit

Permalink
docs(readme): added action to create release
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertoChiosa committed Aug 13, 2024
1 parent 9b80501 commit 305fddc
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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]
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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
27 changes: 27 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Features:

- Added command line interface for the tool
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "cmp"
version = "0.1.0"
version = "0.1.1"
description = ""
authors = ["RobertoChiosa <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit 305fddc

Please sign in to comment.