Merge pull request #35 from btnguyen2k/dev

Prepare to release first version

Author: btnguyen2k

.github/workflows/release.yaml

@@ -88,12 +88,12 @@ jobs:
             echo ========== commit updates ==========
             git config --global user.email "<>"
             git config --global user.name "CI Build"
-            git commit -am "Update ${FILE_CHANGELOG} and ${FILE_MODULE} for new version ${VERSION}"
-            echo FIXME git push origin ${BRANCH_TO_RELEASE}
+            git commit -am "Update ${FILE_CHANGELOG}, ${FILE_MODULE} and *.go files for new version ${VERSION}"
+            git push origin ${BRANCH_TO_RELEASE}
 
             echo ========== tag ==========
             git tag -f -a "${TAG_PREFIX}${VERSION}" -m "Release ${TAG_PREFIX}/v${VERSION}"
-            echo FIXME git push origin "${TAG_PREFIX}${VERSION}" -f
+            git push origin "${TAG_PREFIX}${VERSION}" -f
             echo "✅ Done."
           else
             echo "❎ SKIPPED."
@@ -118,7 +118,7 @@ jobs:
             const {data: pr} = await github.rest.pulls.create({
               owner: context.repo.owner,
               repo: context.repo.repo,
-              title: "Merge branch semver to master after releasing new version ${{ needs.Release.outputs.VERSION }}",
+              title: "Merge to main after releasing new version ${{ needs.Release.outputs.VERSION }}",
               body: process['env']['RELEASE_NOTES'],
               head: process['env']['BRANCH_TO_RELEASE'],
               base: 'main',

README.md

@@ -15,14 +15,6 @@ Template to quickly spin up a Go module project.
   - `ci.yaml`: automatically run tests and generate code coverage report.
   - `release.yaml`: automatically create a new release.
 
-**Workflow**
-
-Workflow implemented by this template is as the following:
-
-- Dependencies are checked and updated weekly by `dependabot.yaml`, and then PRs are automatically merged to `main` branch by `automerge-dependabot.yaml`.
-- `ci.yaml` is triggered on every push to any branch to run tests and generate code coverage report.
-- Once PR is approved and merged to `release` branch, `release.yaml` is triggered to create a new release. Then a new PR is created to merge `release` branch to `main` branch.
-
 ## Usage
 
 1. Create new project from this template:
@@ -35,6 +27,23 @@ Workflow implemented by this template is as the following:
 5. Update other files to suit your needs.
 6. Happy coding!
 
+**Workflows**
+
+Workflows implemented by this template are as the following:
+
+- Dependencies are checked and updated weekly by `dependabot.yaml`, and then PRs are automatically merged to `main` branch by `automerge-dependabot.yaml`.
+- `ci.yaml` is triggered on every push to any branch to run tests and generate code coverage report.
+- Once PR is approved and merged to `release` branch, `release.yaml` is triggered to create a new release. Then a new PR is created to merge `release` branch to `main` branch.
+
+A suggested git workflow to use with this template is as the following:
+
+- Work on your code in development/feature branches as usual.
+- Once ready, create a PR to merge your development/feature branch to `release` branch.
+  - Workflow `release.yaml` will be triggered to create a new release.
+  - Then a new PR will be created to merge `release` branch to `main` branch. Note: you have to review and approve the PR by yourself to finalize the merge.
+
+> Remember to enable the setting "Allow GitHub Actions to create and approve pull requests" from project's `Settings -> Actions -> General`.
+
 ## License
 
 This template is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.