Release v1.12.0

.github/workflows/go.yml

@@ -15,49 +15,12 @@ on:
       - 'docs/**'
 
 jobs:
-  MIGRATION-Unit-Testing:
-    name: Migration Unit Testing (v${{ matrix.go-version }})🛠
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        go-version: ['1.21', '1.20']
-
-    steps:
-      - name: Checkout code into go module directory
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Go ${{ matrix.go-version }}
-        uses: actions/setup-go@v4
-        with:
-          go-version: ${{ matrix.go-version }}
-        id: Go
-
-      - name: Get dependencies
-        run: |
-          go mod download
-
-      - name: Test
-        run: |
-          export APP_ENV=test
-          go test gofr.dev/pkg/gofr/migration... -v -short -coverprofile profile.cov -coverpkg=gofr.dev/pkg/gofr/migration...
-
-          go tool cover -func profile.cov
-
-      - name: Upload Test Coverage
-        if: ${{ matrix.go-version == '1.21'}}
-        uses: actions/upload-artifact@v3
-        with:
-          name: MIGRATION-Coverage-Report
-          path: profile.cov
-
   Example-Unit-Testing:
     name: Example Unit Testing (v${{ matrix.go-version }})🛠
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: ['1.21', '1.20']
+        go-version: ['1.22', '1.21']
 
     services:
       kafka:
@@ -118,7 +81,7 @@ jobs:
           go tool cover -func profile.cov
 
       - name: Upload Test Coverage
-        if: ${{ matrix.go-version == '1.21'}}
+        if: ${{ matrix.go-version == '1.22'}}
         uses: actions/upload-artifact@v3
         with:
           name: Example-Test-Report
@@ -129,7 +92,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: ['1.21', '1.20']
+        go-version: ['1.22', '1.21']
 
     steps:
       - name: Checkout code into go module directory
@@ -150,15 +113,12 @@ jobs:
       - name: Test
         run: |
           export APP_ENV=test
-          go test gofr.dev/pkg/... -tags migration -v -short -coverprofile packageWithMigration.cov -coverpkg=gofr.dev/pkg/...
-          grep -v 'gofr.dev/pkg/gofr/migration' packageWithMigration.cov > packageWithoutMigration.cov
-          grep -v 'gofr.dev/pkg/gofr/migration/mock_datasources.go' packageWithoutMigration.cov > packageWithoutMockMigrationDatasource.cov
-          grep -v 'gofr.dev/pkg/gofr/container/mock_datasources.go' packageWithoutMockMigrationDatasource.cov > packageWithoutMockDatasource.cov
-          grep -v 'google/mock_interfaces\.go' packageWithoutMockDatasource.cov > profile.cov
+          go test gofr.dev/pkg/... -v -short -coverprofile package.cov -coverpkg=gofr.dev/pkg/...
+          grep -v '/mock_' package.cov > profile.cov
           go tool cover -func profile.cov
 
       - name: Upload Test Coverage
-        if: ${{ matrix.go-version == '1.21'}}
+        if: ${{ matrix.go-version == '1.22'}}
         uses: actions/upload-artifact@v3
         with:
           name: PKG-Coverage-Report
@@ -167,7 +127,7 @@ jobs:
   parse_coverage:
     name: Code Coverage
     runs-on: ubuntu-latest
-    needs: [ Example-Unit-Testing,PKG-Unit-Testing,MIGRATION-Unit-Testing ]
+    needs: [ Example-Unit-Testing,PKG-Unit-Testing]
     steps:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v4
@@ -183,7 +143,6 @@ jobs:
         run: |
           awk '!/^mode: / && FNR==1{print "mode: set"} {print}' ./Example-Test-Report/profile.cov > merged_profile.cov
           tail -n +2 ./PKG-Coverage-Report/profile.cov >> merged_profile.cov
-          tail -n +2 ./MIGRATION-Coverage-Report/profile.cov >> merged_profile.cov
 
       - name: Parse code-coverage value
         working-directory: artifacts
@@ -201,7 +160,7 @@ jobs:
   upload_coverage:
     name: Upload Coverage📊
     runs-on: ubuntu-latest
-    needs: [Example-Unit-Testing,PKG-Unit-Testing,MIGRATION-Unit-Testing]
+    needs: [Example-Unit-Testing,PKG-Unit-Testing]
     if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development'}}
     steps:
       - name: Check out code into the Go module directory

.github/workflows/website.yml → .github/workflows/website_prod.yml

@@ -2,7 +2,10 @@ name: Build and Deploy
 on:
   push:
     tags:
-      - "v[0-9]+.[0-9]+.[0-9]"
+      - "v*.*.*"
+    branches:
+      - main
+      - development
 
 env:
   APP_NAME: gofr-website
@@ -15,9 +18,6 @@ env:
 jobs:
   build:
     runs-on: ubuntu-latest
-    if: (github.ref == 'refs/heads/development' || github.ref == 'refs/heads/main' || github.event_name == 'pull_request' )
-    outputs:
-      image: ${{ steps.output-image.outputs.image }}
     name: 🔧Build
     steps:
       - name: Checkout Code
@@ -37,20 +37,16 @@ jobs:
         run: |
           docker pull ${{ env.WEBSITE_REGISTRY }}/gofr-dev/website:latest
 
-      - name: Build and Push Image Stage
+      - name: Build Image
         uses: docker/build-push-action@v4
         with:
           push: false
           context: ./
           file: ./docs/Dockerfile
-          tags: us-central1-docker.pkg.dev/${{ env.GAR_PROJECT }}/${{ env.GAR_REGISTRY }}/${{ env.APP_NAME }}:${{ github.sha }}
-
-      - id: output-image
-        run: echo "image=`echo us-central1-docker.pkg.dev/${{ env.GAR_PROJECT }}/${{ env.GAR_REGISTRY }}/${{ env.APP_NAME }}:${{ github.sha }}`" >> "$GITHUB_OUTPUT"
 
   dockerize:
-    runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref, 'refs/tags/v')}}
+    runs-on: ubuntu-latest
     outputs:
       image: ${{ steps.output-image.outputs.image }}
     name: 🐳 Dockerize

CODE_OF_CONDUCT.md

@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

@@ -81,7 +81,7 @@ Please note that the recommended local port for the services are different than
 * Use only what is given to you as part of function parameter or receiver. No globals. Inject all dependencies including
   DB, Logger etc.
 * No magic. So, no init. In a large project, it becomes difficult to track which package is doing what at the
-  initialisation step.
+  initialization step.
 * Exported functions must have an associated goDoc.
 * Sensitive data(username, password, keys) should not be pushed. Always use environment variables.
 * Take interfaces and return concrete types.
@@ -107,7 +107,7 @@ Please note that the recommended local port for the services are different than
 * When you consider a new documentation page is needed, start by adding a new file and writing your new documentation. Then - add a reference to it in [navigation.js](https://gofr.dev/docs/navigation.js).
 * If needed, update or add proper code examples for your changes.
 * In case images are needed, add it to [docs/public](https://gofr.dev/docs/public) folder.
-* Make sure you don't break existing links and refernces.
+* Make sure you don't break existing links and references.
 * Maintain Markdown standards, you can read more [here](https://www.markdownguide.org/basic-syntax/), this includes:
     - Headings (`#`, `##`, etc.) should be placed in order.
     - Use trailing white space or the <br> HTML tag at the end of the line.

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.21
+FROM golang:1.22
 
 RUN mkdir -p /go/src/gofr.dev
 WORKDIR /go/src/gofr.dev
@@ -10,4 +10,4 @@ FROM alpine:latest
 RUN apk add --no-cache tzdata ca-certificates
 COPY --from=0 /go/src/gofr.dev/main /main
 EXPOSE 8000
-CMD ["/main"]
+CMD ["/main"]

README.md

@@ -39,4 +39,4 @@ If you want to say thank you and/or support the active development of GoFr:
 
 1. Add a [GitHub Star](https://github.com/gofr-dev/gofr/stargazers) to the project.
 2. Write a review or tutorial on [Medium](https://medium.com/), [Dev.to](https://dev.to/) or personal blog.
-3. Visit [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow. After your PR is merged to the repo, fill the [google form](https://forms.gle/R1Yz7ZzY3U5WWTgy5), and we will send you a GoFr T-Shirt and Stickers as a token of appreciation. 
+3. Visit [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow. After your PR is merged to the repo, fill the [Google Form](https://forms.gle/R1Yz7ZzY3U5WWTgy5), and we will send you a GoFr T-Shirt and Stickers as a token of appreciation.

SECURITY.md

@@ -11,4 +11,4 @@ Following versions are being supported for security updates.
 
 ## Reporting a Vulnerability
 
-To report a vulnerability, please file an issue on this repo and add "security" label. Security related issues will be prioritised over others. We strive to triage the issue within a single working day.
+To report a vulnerability, please file an issue on this repo and add "security" label. Security related issues will be prioritized over others. We strive to triage the issue within a single working day.

docs/advanced-guide/gofr-errors/page.md

@@ -12,6 +12,10 @@ automatically handle HTTP status code selection. These include:
 - `ErrorInvalidParam`: Represents an error due to an invalid parameter.
 - `ErrorMissingParam`: Represents an error due to a missing parameter.
 - `ErrorEntityNotFound`: Represents an error due to a not found entity.
+- `ErrorEntityAlreadyExist`: Represents an error due to creation of duplicate entity.
+- `ErrorInvalidRoute`: Represents an error for invalid route.
+- `ErrorRequestTimeout`: Represents an error for request which timed out.
+- `ErrorPanicRecovery`: Represents an error for request which panicked.
 
 #### Usage:
 To use the predefined http errors,users can simply call them using GoFr's http package:

docs/advanced-guide/grpc/page.md

@@ -120,4 +120,4 @@ func main() {
 	app.Run()
 }
 ```
->Note: By default, grpc server will run on port 9000, to customize the port users can set GRPC_PORT config in the .env
+>Note: By default, gRPC server will run on port 9000, to customize the port users can set `GRPC_PORT` config in the .env

docs/advanced-guide/handling-data-migrations/page.md

@@ -46,7 +46,7 @@ func createTableEmployee() migration.Migrate {
 }
 ```
 
-`migration.Datasource` have the datasources whose migrations are supported i.e. Redis and SQL (MySQL and PostgreSQL).
+`migration.Datasource` have the datasources whose migrations are supported i.e., Redis and SQL (MySQL and PostgreSQL).
 All migrations always run in a transaction.
 
 For MySQL it is highly recommended to use `IF EXISTS` and `IF NOT EXIST` in DDL commands as MySQL implicitly commits these commands.
@@ -147,7 +147,7 @@ Value : {"method":"UP","startTime":"2024-02-26T15:03:46.844558+05:30","duration"
 
 Where,
 
-**Version** : Migration version is the number provided in the map, i.e. sequence number.
+**Version** : Migration version is the number provided in the map, i.e., sequence number.
 
 **Start Time** : Time when Migration Started in UTC.
 

docs/advanced-guide/handling-file/page.md

@@ -1,6 +1,6 @@
 # Handling File
 
-Gofr simplifies the complexity of working with different filestores by offering a uniform API. This allows developers to interact with different storage systems using the same set of methods, without needing to understand the underlying implementation details of each filestore.
+GoFr simplifies the complexity of working with different file stores by offering a uniform API. This allows developers to interact with different storage systems using the same set of methods, without needing to understand the underlying implementation details of each file store.
 
 ## USAGE
 
@@ -82,4 +82,4 @@ err := c.File.RemoveAll("my_dir/my_text")
 ```
 
 
-> Errors have been skipped in the example to focus on the core logic, it is recommended to handle all the errors.
+> Errors have been skipped in the example to focus on the core logic, it is recommended to handle all the errors.

docs/advanced-guide/overriding-default/page.md

@@ -4,7 +4,7 @@ GoFr allows overriding default behavior of its features.
 
 ## Raw response format
 
-GoFr by default wraps a handler's return value and assigns it to the "data" field in a response.
+GoFr by default wraps a handler's return value and assigns it to the `data` field in a response.
 
 ### Example
 
@@ -74,7 +74,7 @@ Response example:
 
 ## Favicon.ico
 
-By default GoFr load its own `favicon.ico` present in root directory for an application. To override `favicon.ico` user
+By default, GoFr load its own `favicon.ico` present in root directory for an application. To override `favicon.ico` user
 can place its custom icon in the **static** directory of its application.
 
-> NOTE: The custom favicon should also be named as `favicon.ico` in the static directory of application.
+> NOTE: The custom favicon should also be named as `favicon.ico` in the static directory of application.