create release on tag

Athou · May 1, 2023 · 42ca096 · 42ca096
1 parent deb29f0
commit 42ca096
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 12 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -10,7 +10,8 @@ jobs:
         java: [ "8", "11", "17" ]
 
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
@@ -32,16 +33,29 @@ jobs:
       - name: Build with Maven
         run: mvn --batch-mode --update-snapshots verify
 
-      - uses: actions/upload-artifact@v3
+      - name: Upload JAR
+        uses: actions/upload-artifact@v3
         if: ${{ matrix.java == '8' }}
         with:
           name: commafeed.jar
           path: commafeed-server/target/commafeed.jar
 
-      # Docker
+      - name: Create release
+        uses: softprops/action-gh-release@v1
+        if: ${{ matrix.java == '8' && github.ref_type == 'tag' }}
+        with:
+          name: CommaFeed ${{ github.ref_name }}
+          body: See changelog at https://github.com/Athou/commafeed/blob/master/CHANGELOG.md
+          draft: false
+          prerelease: false
+          files: |
+            commafeed-server/target/commafeed.jar
+            commafeed-server/config.yml.example
+
+          # Docker
       - name: Login to Container Registry
-        if: ${{ matrix.java == '8' }}
         uses: docker/login-action@v2
+        if: ${{ matrix.java == '8' }}
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}

diff --git a/README.md b/README.md
@@ -34,9 +34,8 @@ Docker images are built automatically and are available at https://hub.docker.co
 ### Download precompiled package
 
     mkdir commafeed && cd commafeed
-    wget https://github.com/Athou/commafeed/releases/download/3.0.1/commafeed.jar
-    wget https://raw.githubusercontent.com/Athou/commafeed/3.0.1/commafeed-server/config.yml.example -O config.yml
-    vi config.yml
+    wget https://github.com/Athou/commafeed/releases/latest/download/commafeed.jar
+    wget https://github.com/Athou/commafeed/releases/latest/download/config.yml.example -O config.yml
     java -Djava.net.preferIPv4Stack=true -jar commafeed.jar server config.yml
 
 The server will listen on http://localhost:8082. The default
@@ -48,7 +47,6 @@ user is `admin` and the default password is `admin`.
     cd commafeed
     ./mvnw clean package
     cp commafeed-server/config.yml.example config.yml
-    vi config.yml
     java -Djava.net.preferIPv4Stack=true -jar commafeed-server/target/commafeed.jar server config.yml
 
 The server will listen on http://localhost:8082. The default
@@ -76,17 +74,16 @@ two-letters [ISO-639-1 language code](http://en.wikipedia.org/wiki/List_of_ISO_6
 
 - Open `commafeed-server` in your preferred Java IDE.
     - CommaFeed uses Lombok, you need the Lombok plugin for your IDE.
-    - If using Eclipse, Go to Window → Preferences → Maven → Annotation Processing and check "Automatically configure
-      JDT APT"
 - Start `CommaFeedApplication.java` in debug mode with `server config.dev.yml` as arguments
 
 ### Frontend
 
 - Open `commafeed-client` in your preferred JavaScript IDE.
 - run `npm install`
 - run `npm run dev`
-- the frontend server is now running at http://localhost:8082 and is proxying REST requests to the backend running on
-  port 8083
+
+The frontend server is now running at http://localhost:8082 and is proxying REST requests to the backend running on
+port 8083
 
 ## Copyright and license