Prepare the first release files

- Updated the GitHub Actions files to include release steps - Added a contribution guide
habedi · Jan 17, 2025 · c11f1ff · c11f1ff
1 parent 8392c79
commit c11f1ff
Show file tree

Hide file tree

Showing 9 changed files with 115 additions and 29 deletions.
diff --git a/.github/workflows/build_linux.yml b/.github/workflows/build_linux.yml
@@ -1,7 +1,10 @@
 name: Linux Build
 
 on:
-    workflow_dispatch: # Only enable manual runs for now
+    workflow_dispatch:
+    push:
+        tags:
+            - 'v*' # Trigger on version tags (e.g., v1.0.0)
 
 jobs:
     build:
@@ -36,11 +39,24 @@ jobs:
             -   name: List Build Directory
                 run: ls -R bin
 
-            # Archive the build artifacts
-            -   name: Archive Build Artifacts
-                uses: actions/upload-artifact@v4
+            # Upload Build Artifact (always runs)
+            -   name: Upload Build Artifact
+                uses: actions/upload-artifact@v3
                 with:
                     name: gogg-linux-amd64
                     path: 'bin/gogg'
 
-
+            # Conditional Release Creation (only runs on tag push)
+            -   name: Create GitHub Release
+                if: startsWith(github.ref, 'refs/tags/')
+                uses: ncipollo/release-action@v1
+                with:
+                    artifacts: "bin/gogg"
+                    token: ${{ secrets.GITHUB_TOKEN }}
+                    name: ${{ github.ref_name }}
+                    tag: ${{ github.ref_name }}
+                    body: |
+                        Release version ${{ github.ref_name }}
+                        - Built for Linux (amd64)
+                    draft: false
+                    prerelease: false
diff --git a/.github/workflows/build_mac.yml → .github/workflows/build_macos.yml b/.github/workflows/build_mac.yml → .github/workflows/build_macos.yml
@@ -1,7 +1,10 @@
 name: MacOS Build
 
 on:
-    workflow_dispatch: # Only enable manual runs for now
+    workflow_dispatch:
+    push:
+        tags:
+            - 'v*' # Trigger on version tags (e.g., v1.0.0)
 
 jobs:
     build:
@@ -30,17 +33,30 @@ jobs:
             -   name: Build for MacOS
                 run: |
                     make build-macos
-
                 continue-on-error: false
 
             # Debug: List Build Directory
             -   name: List Build Directory
                 run: ls -R bin
 
-            # Archive the build artifacts
-            -   name: Archive Build Artifacts
-                uses: actions/upload-artifact@v4
+            # Upload Build Artifact (always runs)
+            -   name: Upload Build Artifact
+                uses: actions/upload-artifact@v3
                 with:
                     name: gogg-macos-universal
                     path: 'bin/gogg'
 
+            # Conditional Release Creation (only runs on tag push)
+            -   name: Create GitHub Release
+                if: startsWith(github.ref, 'refs/tags/')
+                uses: ncipollo/release-action@v1
+                with:
+                    artifacts: "bin/gogg"
+                    token: ${{ secrets.GITHUB_TOKEN }}
+                    name: ${{ github.ref_name }}
+                    tag: ${{ github.ref_name }}
+                    body: |
+                        Release version ${{ github.ref_name }}
+                        - Built for macOS Universal Binary
+                    draft: false
+                    prerelease: false
diff --git a/.github/workflows/build_win.yml → .github/workflows/build_windows.yml b/.github/workflows/build_win.yml → .github/workflows/build_windows.yml
@@ -1,7 +1,10 @@
 name: Windows Build
 
 on:
-    workflow_dispatch: # Only enable manual runs for now
+    workflow_dispatch:
+    push:
+        tags:
+            - 'v*' # Trigger on version tags (e.g., v1.0.0)
 
 jobs:
     build:
@@ -36,11 +39,24 @@ jobs:
             -   name: List Build Directory
                 run: ls -R bin
 
-            # Archive the build artifacts
-            -   name: Archive Build Artifacts
-                uses: actions/upload-artifact@v4
+            # Upload Build Artifact (always runs)
+            -   name: Upload Build Artifact
+                uses: actions/upload-artifact@v3
                 with:
                     name: gogg-windows-amd64
                     path: 'bin/gogg.exe'
 
-
+            # Conditional Release Creation (only runs on tag push)
+            -   name: Create GitHub Release
+                if: startsWith(github.ref, 'refs/tags/')
+                uses: ncipollo/release-action@v1
+                with:
+                    artifacts: "bin/gogg.exe"
+                    token: ${{ secrets.GITHUB_TOKEN }}
+                    name: ${{ github.ref_name }}
+                    tag: ${{ github.ref_name }}
+                    body: |
+                        Release version ${{ github.ref_name }}
+                        - Built for Windows (amd64)
+                    draft: false
+                    prerelease: false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contributing to Gogg
+
+Thank you for considering contributing to Gogg.
+Contributions are always welcome and appreciated.
+
+## How to Contribute
+
+### Reporting Bugs
+
+1. Open an issue on the [issue tracker](https://github.com/habedi/gogg/issues).
+2. Include information like steps to reproduce, expected/actual behaviour, and relevant logs or screenshots.
+
+### Suggesting Features
+
+1. Open an issue on the [issue tracker](https://github.com/habedi/gogg/issues).
+2. Write a little about the feature, its purpose, and potential implementation ideas.
+
+## Submitting Pull Requests
+
+- Make sure all tests pass before submitting a pull request.
+- Write a clear description of the changes you made and why you made them for the pull request.
+
+## Code Style
+
+- Use the `make format` command to format the code.
+
+## Running Tests
+
+- Use the `make test` command to run the unit tests.
+
+## Miscellaneous
+
+- Run `make help` to see all available commands to manage different tasks.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <div align="center">
   <picture>
-    <source media="(prefers-color-scheme: light)" srcset="assets/logo-v1.jpeg">
-    <source media="(prefers-color-scheme: dark)" srcset="assets/logo-v1.jpeg">
-    <img alt="Gogg logo" src="assets/logo-v1.jpeg" height="35%" width="35%">
+    <source media="(prefers-color-scheme: light)" srcset="logo.jpeg">
+    <source media="(prefers-color-scheme: dark)" srcset="logo.jpeg">
+    <img alt="Gogg logo" src="logo.jpeg" height="40%" width="40%">
   </picture>
 </div>
 <br>
@@ -20,10 +20,16 @@
   <a href="https://github.com/habedi/gogg/releases/latest">
     <img src="https://img.shields.io/github/release/habedi/gogg.svg?style=flat-square" alt="Release">
   </a>
-  <a href="https://snapcraft.io/gogg">
-  <img src="https://snapcraft.io/gogg/badge.svg" alt="Snap Store">
+  <br>
+  <a href="https://github.com/habedi/gogg/actions/workflows/build_linux.yml">
+    <img src="https://github.com/habedi/gogg/actions/workflows/build_linux.yml/badge.svg" alt="Linux Build">
+  </a>
+  <a href="https://github.com/habedi/gogg/actions/workflows/build_windows.yml">
+    <img src="https://github.com/habedi/gogg/actions/workflows/build_windows.yml/badge.svg" alt="Windows Build">
+  </a>
+  <a href="https://github.com/habedi/gogg/actions/workflows/build_macos.yml">
+    <img src="https://github.com/habedi/gogg/actions/workflows/build_macos.yml/badge.svg" alt="MacOS Build">
   </a>
-
 </p>
 
 # Gogg
@@ -56,6 +62,8 @@ Additionally, it allows users to perform the following actions:
 
 See the [documentation](docs/README.md) for how to install and use Gogg.
 
+Run `gogg -h` to see the available commands and options.
+
 ### Examples
 
 For more detailed examples, see the content of the [examples](docs/examples/) directory.
@@ -76,8 +84,8 @@ gogg auth
 ```
 
 > You must have [Google Chrome](https://www.google.com/chrome/) or [Chromium](https://www.chromium.org/) installed
-on your machine for the first-time authentication. 
-So, make sure you have one of them installed.
+> on your machine for the first-time authentication.
+> So, make sure you have one of them installed.
 
 #### Syncing the Game Catalogue
 
@@ -93,6 +101,6 @@ gogg catalogue refresh
 gogg download --id 1207658924 --dir ./games --platform windows --lang en --dlcs true --extras true --resume true --threads 5
 ```
 
-## Bugs and Features
+## Contributing
 
-Use the [issue tracker](github.com/habedi/gogg/issues) to report a bug or ask for a feature.
+Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for information on how to contribute to Gogg.
diff --git a/assets/workflow.dot b/assets/workflow.dot
diff --git a/docs/README.md b/docs/README.md
@@ -10,11 +10,8 @@
 
 You can download the binary builds of Gogg for your operating system
 from the [releases page](https://github.com/habedi/gogg/releases).
-
 You might want to add the binary to your system's PATH to use it from anywhere on your system.
 
-Run `gogg -h` to see the available commands and options.
-
 ## Usage
 
 ### First Time Setup

diff --git a/assets/logo-v1.jpeg → logo.jpeg b/assets/logo-v1.jpeg → logo.jpeg
diff --git a/main.go b/main.go
@@ -23,7 +23,7 @@ func main() {
 	signal.Notify(stopChan, os.Interrupt)
 	go listenForInterrupt(stopChan)
 
-	// Execute the CLI program
+	// Program entry point
 	cmd.Execute()
 }