format-check

.github/workflows/pipeline.yml

@@ -1,12 +1,17 @@
 name: CI Checks
 
 on:
+  pull_request:
+    branches:
+      - main
   push:
     branches:
       - main
 
 jobs:
   test:
+    needs:
+      - format-check
     name: Test Application
     runs-on: ubuntu-latest
     steps:
@@ -87,24 +92,38 @@ jobs:
         with:
           name: api
           path: artifacts
-  deploy-paas:
-    name: Deploy PaaS
+  format-check:
+    name: Check formatting
     runs-on: ubuntu-latest
-    needs: test
     steps:
-      - name: Check out cod einto the Go module directory
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - id: auth
-        uses: google-github-actions/auth@v2
-        with:
-          project_id: djengua-203420
-          credentials_json: ${{ secrets.GCP_CREDENTIALS_2 }}
-          export_default_credentials: true
-      - id: deploy
-        uses: google-github-actions/deploy-appengine@v1
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
         with:
-          creedentials: ${{ secrets.GCP_CREDENTIALS_2 }}
-      - id: test
-        run: curl "${{ steps.deploy.outputs.url }}/hello"
+          go-version: ^1.2
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+      - name: Run Format Check
+        run: make check-format
+
+  # deploy-paas:
+
+  #   name: Deploy PaaS
+  #   runs-on: ubuntu-latest
+  #   needs: test
+  #   steps:
+  #     - name: Check out cod einto the Go module directory
+  #       uses: actions/checkout@v2
+  #       with:
+  #         fetch-depth: 0
+  #     - id: auth
+  #       uses: google-github-actions/auth@v2
+  #       with:
+  #         project_id: djengua-203420
+  #         credentials_json: ${{ secrets.GCP_CREDENTIALS_2 }}
+  #         export_default_credentials: true
+  #     - id: deploy
+  #       uses: google-github-actions/deploy-appengine@v1
+  #       with:
+  #         creedentials: ${{ secrets.GCP_CREDENTIALS_2 }}
+  #     - id: test
+  #       run: curl "${{ steps.deploy.outputs.url }}/hello"

Makefile

@@ -8,5 +8,6 @@ coverage:
 	go tool cover -func coverage.out | grep "total:" | awk '{print ((int($$3) > 80) != 1 )}'
 report:
 	go tool cover -html=coverage.out -o cover.html
-
+check-format:
+	test -z $$(go fmt ./...)
 .PHONY: build server test coverage report

README.md

@@ -1,15 +1,27 @@
 # Rifa api
 
+### Description
+Explain the changes you made here.
+
+### Associated Task
+Please list closed, fixed, or resolved issues here with a # and the number.
+
+### Checklist
+- [ ] Code compiles correctly
+- [ ] Added tests that fail without the change (if possible)
+- [ ] All tests passing
+- [ ] Extended the documentation
+
 ## Release Milestones
 
 ### V0 (1 day)
-- [] Onboarding documentation
-- [] Simple API response (hello world!)
-- [] Unit tests
-- [] Running somewhere other than the dev machine
+- [ ] Onboarding documentation
+- [ ] Simple API response (hello world!)
+- [ ] Unit tests
+- [ ] Running somewhere other than the dev machine
 
 ### V1 (7 days)
-- [] Create translation endpoint
-- [] Store translations in short-term storage
-- [] Call existing service for translation
-- [] Move towards long-term storage
+- [ ] Create translation endpoint
+- [ ] Store translations in short-term storage
+- [ ] Call existing service for translation
+- [ ] Move towards long-term storage