From 7c0746bfd8eff0cc58084ba03bb79aaef885442f Mon Sep 17 00:00:00 2001 From: Riandy Rahman Nugraha Date: Fri, 21 Jul 2023 10:30:21 +0700 Subject: [PATCH 1/3] docs: proofread README.md; --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5e67afe8..866dfc3b 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ `Hex Monscape` is a simple turn-based game to make Haraj Solutions Team onboarding more fun. -In the game code, you can find the team's secret technique in writing production code for [Haraj](https://haraj.com.sa) services that help serve millions of people daily in Saudi Arabia despite only having a handful of members. 🥷🏻💥 +In the game code, you can find the team's secret technique in writing production code for [Haraj](https://haraj.com.sa) services that help serve millions of people daily in Saudi Arabia despite only having a handful of team members. 🥷🏻💥 The secret technique actually lies in the architecture we choose for these services: [Hexagonal Architecture](./docs/reference/hex-architecture.md). -By using this remarkable architecture, not only can we speed up the development process of these services but also make them maintainable by the whole team. This is why even though our team is small, we can still develop services that help serve millions in Saudi Arabia without sabotaging our good sleep at night. 🤣 +By using this remarkable architecture, not only can we speed up the development process of these services but also make them **maintainable** by the whole team. This is why even though our team is small, we can still do our job properly without losing good sleep at night. 🤣 -This game was created using [Golang](https://go.dev/) & [Vue 3](https://vuejs.org/). To learn how we apply [Hexagonal Architecture](./docs/reference/hex-architecture.md) to the game, please refer to [this doc](./docs/reference/hex-architecture.md). +The game was created using [Golang](https://go.dev/) & [Vue 3](https://vuejs.org/). To learn how we apply [Hexagonal Architecture](./docs/reference/hex-architecture.md) to the game, please refer to [this doc](./docs/reference/hex-architecture.md). To start playing the game, please refer to [How to Run The Game](#how-to-run-the-game) section. @@ -22,7 +22,7 @@ To start playing the game, please refer to [How to Run The Game](#how-to-run-the > > Many people got interested in software engineering because of games. So using them to exchange knowledge within our team seems like a fun idea. This is why we created this project. 😃 > -> Even though we are using Golang to implement [Hexagonal Architecture](./docs/reference/hex-architecture.md) in this repo, the architecture itself is language agnostic. So we can also apply it to other languages such as PHP, Typescript, & Python. This is why we believe this repo could also be useful for other software developers outside our team. 😁 +> Even though we are using Golang to implement [Hexagonal Architecture](./docs/reference/hex-architecture.md) in this repo, the architecture itself is language agnostic. So we can also apply it to other languages such as PHP, Typescript, & Python. ## Background Story From 3eaa78be46a9076da72b3908359e2666ec400e8c Mon Sep 17 00:00:00 2001 From: Riandy Rahman Nugraha Date: Fri, 21 Jul 2023 10:36:11 +0700 Subject: [PATCH 2/3] chore: remove coverage-badge.yml since the coverage reports will be now integrated with ci.yml, this is so the contributor knows the coverage rate of their PR; --- .github/workflows/ci.yml | 11 ++++++++ .github/workflows/coverage-badge.yml | 41 ---------------------------- .github/workflows/deploy.yml | 1 - 3 files changed, 11 insertions(+), 42 deletions(-) delete mode 100644 .github/workflows/coverage-badge.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6c7aaa8b..2caf5971 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,6 +5,12 @@ on: paths-ignore: - '**.md' - 'docs/**' + push: + branches: + - master + paths-ignore: + - '**.md' + - 'docs/**' jobs: run-tests: @@ -19,6 +25,11 @@ jobs: - name: Run Automated Tests run: make test + - name: Send Coverage Report to Coveralls + uses: shogo82148/actions-goveralls@v1 + with: + path-to-profile: ./.output/cov-report/profile.cov + - name: Test Build All Container Images run: make test-build-all diff --git a/.github/workflows/coverage-badge.yml b/.github/workflows/coverage-badge.yml deleted file mode 100644 index d764765b..00000000 --- a/.github/workflows/coverage-badge.yml +++ /dev/null @@ -1,41 +0,0 @@ -name: coverage-badge - -on: - push: - paths-ignore: - - 'Makefile' - - '**.md' - - 'docs/**' - branches: - - master - -jobs: - update-badge: - name: Update Coverage Badge - runs-on: ubuntu-latest - steps: - - name: Checkout Current Commit - uses: actions/checkout@v3 - - - name: Generate Coverage Report - run: make test - - - name: Send Coverage Report to Coveralls - uses: shogo82148/actions-goveralls@v1 - with: - path-to-profile: ./.output/cov-report/profile.cov - - - name: Notify To Slack If Failed - uses: lazy-actions/slatify@v3.0.0 - if: failure() - with: - type: ${{ job.status }} - job_name: "*[hex-monscape]* ${{ github.job }}" - mention: "here" - mention_if: "failure" - channel: "#solutions-team-ci-cd" - icon_emoji: ":haraaj:" - username: "ci/cd-reporter" - url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }} - commit: true - token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 99d6c894..e3cc5ebc 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -3,7 +3,6 @@ name: deploy on: push: paths-ignore: - - 'Makefile' - '**.md' - 'docs/**' branches: From 3008047cbcaf4f6716383daf66e1a82cd79ab837 Mon Sep 17 00:00:00 2001 From: Riandy Rahman Nugraha Date: Fri, 21 Jul 2023 10:44:51 +0700 Subject: [PATCH 3/3] chore: ignore Makefile in deploy.yml; --- .github/workflows/deploy.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index e3cc5ebc..99d6c894 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -3,6 +3,7 @@ name: deploy on: push: paths-ignore: + - 'Makefile' - '**.md' - 'docs/**' branches: