chore: update file names in build and release workflows

.github/workflows/build.yml

@@ -9,7 +9,7 @@ on:
       - '.github/**'
       - '.gitignore'
       - 'makefile'
-      - 'config.yaml.example'
+      - 'config.example.yaml'
       - 'script/**'
       - '.vscode/**'
   pull_request:
@@ -20,7 +20,7 @@ on:
       - '.github/**'
       - '.gitignore'
       - 'makefile'
-      - 'config.yaml.example'
+      - 'config.example.yaml'
       - 'script/**'
       - '.vscode/**'
   workflow_dispatch:

.github/workflows/docker_build.yml

@@ -8,7 +8,7 @@ on:
       - '.github/**'
       - '.gitignore'
       - 'makefile'
-      - 'config.yaml.example'
+      - 'config.example.yaml'
       - 'script/**'
       - '.vscode/**'
   workflow_call:

.github/workflows/release.yml

@@ -86,7 +86,7 @@ jobs:
             ${{ needs.setup.outputs.REPO_NAME }}-${{ needs.setup.outputs.TAG_NAME }}-sha256sum.txt
             docker-compose.yml
             Dockerfile
-            config.yaml.example
+            config.example.yaml
           draft: true
           generate_release_notes: true
         env:

.gitignore

@@ -7,7 +7,6 @@ db/
 logs/
 logs/*.log
 
-config.env
 .env
 .venv
 env/
@@ -17,8 +16,8 @@ __debug**
 node_modules/
 robots.txt
 
-/*.yaml
-
+*.yaml
+!*.example.yaml
 
 build/
 dist/

Dockerfile

@@ -35,7 +35,7 @@ COPY --from=builder /app/gogin .
 COPY --from=builder /usr/share/zoneinfo /usr/share/zoneinfo
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 
-COPY ./config.yaml.example /app/config.yaml
+COPY ./config.example.yaml /app/config.yaml
 
 EXPOSE 8080
 

README.md

@@ -19,10 +19,10 @@ If you want to develop with this project, you can follow the steps below.
     git clone [email protected]:funnyzak/go-gin.git && cd go-gin
    ```
 
-2. Copy the `config.yaml.example` file to `config.yaml` and update the values.
+2. Copy the `config.example.yaml` file to `config.yaml` and update the values.
 
    ```bash
-    cp config.yaml.example config.yaml
+    cp config.example.yaml config.yaml
    ```
 
 3. Run the application.
@@ -48,7 +48,7 @@ You can fork this repository and add Secrets Keys: `DOCKER_USERNAME` and `DOCKER
 ├── cmd
 │   ├── main.go             // The main entry point for the application
 │   └── srv                 // Server controller
-├── config.yaml.example     // An example configuration file for the project
+├── config.example.yaml     // An example configuration file for the project
 ├── docker-compose.yml      // Defines services, networks and volumes for docker-compose
 ├── internal
 │   ├── gconfig             // Internal package for configuration
@@ -77,7 +77,7 @@ You can fork this repository and add Secrets Keys: `DOCKER_USERNAME` and `DOCKER
 
 ## Configuration
 
-The configuration file is in the `config.yaml` file, you can copy the `config.yaml.example` file to `config.yaml` and update the values, the configuration file is as follows:
+The configuration file is in the `config.yaml` file, you can copy the `config.example.yaml` file to `config.yaml` and update the values, the configuration file is as follows:
 
 ```yaml
 server:

script/install.sh

@@ -31,7 +31,7 @@ GG_LATEST_VERSION_ZIP_NAME=""
 GG_LATEST_VERSION_DOWNLOAD_URL=""
 
 GG_RAW_URL="https://raw.githubusercontent.com/${GG_GITHUB_REPO_NAME}/main"
-GG_CONFIG_SAMPLE_URL="${GG_RAW_URL}/config.yaml.example"
+GG_CONFIG_SAMPLE_URL="${GG_RAW_URL}/config.example.yaml"
 
 os_arch=""
 [ -e /etc/os-release ] && cat /etc/os-release | grep -i "PRETTY_NAME" | grep -qi "alpine" && os_alpine='1'