diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 7c740bb..9e5831f 100644 --- a/.github/workflows/build.yml +++ b/.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: diff --git a/.github/workflows/docker_build.yml b/.github/workflows/docker_build.yml index d371e7c..c0ac3a5 100644 --- a/.github/workflows/docker_build.yml +++ b/.github/workflows/docker_build.yml @@ -8,7 +8,7 @@ on: - '.github/**' - '.gitignore' - 'makefile' - - 'config.yaml.example' + - 'config.example.yaml' - 'script/**' - '.vscode/**' workflow_call: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 824f329..ce8a58f 100644 --- a/.github/workflows/release.yml +++ b/.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: diff --git a/.gitignore b/.gitignore index 4466569..fdda5b8 100644 --- a/.gitignore +++ b/.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/ diff --git a/Dockerfile b/Dockerfile index ac9bec4..3055d34 100644 --- a/Dockerfile +++ b/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 diff --git a/README.md b/README.md index f69a272..c3f48c2 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@ If you want to develop with this project, you can follow the steps below. git clone git@github.com: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: diff --git a/config.yaml.example b/config.example.yaml similarity index 100% rename from config.yaml.example rename to config.example.yaml diff --git a/script/install.sh b/script/install.sh index b39fc05..c8b7562 100755 --- a/script/install.sh +++ b/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'