File tree Expand file tree Collapse file tree 2 files changed +74
-1
lines changed
Expand file tree Collapse file tree 2 files changed +74
-1
lines changed Original file line number Diff line number Diff line change 11# TodoApp
22
33## Description
4- A command-line todo app that just happened one afternoon. It seemed like a good idea at the time.
4+ A command-line todo app that just happened one afternoon. It seemed like a good idea at the time.
5+
6+ ## Download
7+ You can download the latest release from the [ Releases page] ( https://github.com/gxtm/FileHandler/releases ) .
8+
9+ ## Running the Application
10+ ``` bash
11+ java -jar TodoApp-1.0-SNAPSHOT.jar
12+ ```
13+
14+ ## Available Commands
15+ - ` add ` - Add a new TODO item
16+ - ` list ` - List all TODO items
17+ - ` delete ` or ` remove ` - Delete a TODO item
18+ - ` help ` - Show help information
19+
20+ ## Building from Source
21+ This project uses Maven. To build:
22+ ``` bash
23+ mvn clean package
24+ ```
25+
26+ The JAR file will be created in the ` target/ ` directory.
27+
28+ ## Release Process
29+ See [ RELEASE.md] ( RELEASE.md ) for information about creating releases.
Original file line number Diff line number Diff line change 1+ # Release Process
2+
3+ This project has two GitHub Actions workflows for building and releasing the TodoApp JAR file.
4+
5+ ## CI Workflow (maven.yml)
6+
7+ Runs on every push to ` main ` branch and on pull requests:
8+ - Builds the project with Maven
9+ - Uploads the JAR file as a workflow artifact
10+ - Artifacts are available for download from the Actions tab
11+
12+ ## Release Workflow (release.yml)
13+
14+ Triggers when a version tag is pushed (tags starting with ` v ` , e.g., ` v1.0.0 ` , ` v2.1.3 ` ):
15+ - Builds the project with Maven
16+ - Creates a GitHub Release
17+ - Attaches the JAR file to the release
18+ - Generates release notes automatically
19+
20+ ### Creating a Release
21+
22+ To create a new release:
23+
24+ 1 . Tag your commit with a version number:
25+ ``` bash
26+ git tag v1.0.0
27+ git push origin v1.0.0
28+ ```
29+
30+ 2 . The workflow will automatically:
31+ - Build the JAR file
32+ - Create a GitHub Release with the tag
33+ - Upload the JAR to the release
34+
35+ 3 . The release will be visible at: ` https://github.com/gxtm/FileHandler/releases `
36+
37+ ### JAR File Details
38+
39+ - ** Artifact Name** : ` TodoApp-1.0-SNAPSHOT.jar `
40+ - ** Main Class** : ` me.gixu.Main `
41+ - ** Java Version** : 17
42+
43+ ### Running the JAR
44+
45+ After downloading the JAR from a release, run it with:
46+ ``` bash
47+ java -jar TodoApp-1.0-SNAPSHOT.jar
48+ ```
You can’t perform that action at this time.
0 commit comments