Chore/starting golang project by gbrennon · Pull Request #1 · forging-blocks-org/forging_foundation

gbrennon · 2026-02-10T03:55:41Z

No description provided.

Makefile automates common tasks such as: - testing the codebase - generating code coverage reports - enforcing minimum coverage thresholds - cleaning up generated files - tagging releases

Including an overview, testing instructions, contributor guidelines and release automation workflow.

Those scripts will be used to automated the release process

Copilot

Pull request overview

Initial scaffolding for a Go-based project, including module definition, CI workflows, and release/coverage automation scripts.

Changes:

Added Go module configuration (go.mod) and project README.
Introduced CI + release GitHub Actions workflows running tests and coverage checks.
Added local automation for coverage enforcement and release branching/tagging.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`go.mod`	Defines the module path and Go language version.
`README.md`	Documents project overview, testing, contributor guidance, and release workflow.
`Makefile`	Adds test, coverage, coverage gate, clean, and tag-release targets.
`scripts/release.sh`	Automates release branch creation, changelog generation, and PR creation.
`scripts/next_version.sh`	Computes the next version from git tags.
`.github/workflows/ci.yml`	Runs tests + coverage gate on pushes/PRs.
`.github/workflows/release.yml`	Runs tests + coverage gate on version tag pushes.
`pkg/.gitkeep`	Keeps `pkg/` tracked in git.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

scripts/release.sh

.github/workflows/ci.yml

README.md

scripts/release.sh

Makefile

README.md

scripts/next_version.sh

scripts/release.sh

.github/workflows/release.yml

README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

release automation should support pre-release like alphama, beta, rc, etc. This change adds an optional suffix parameter to the `next_version.sh` script and the `release.sh` script, allowing users to specify a suffix for the version being released. If no suffix is provided, it defaults to a standard patch version bump.

…ocks-org/forging_foundation into chore/starting-golang-project

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ocks-org/forging_foundation into chore/starting-golang-project

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T00:37:41Z

scripts/release.sh

+# Ensure git-chglog configuration exists
+if [ ! -f .chglog/config.yml ]; then
+  echo "Error: git-chglog config file '.chglog/config.yml' not found."
+  echo "Please add it to the repository or update scripts/release.sh to point to the correct config path."
+  exit 1
+fi


The script requires .chglog/config.yml, but that directory/file isn't present in the repository currently, so running release.sh will always exit with the error path. Add the .chglog config (and any templates) to the repo, or update the script/README to use the actual config location.

Copilot · 2026-02-12T00:37:41Z

scripts/release.sh

+
+$DRY_RUN || git push origin "$BRANCH"
+
+CHANGELOG_BODY=$($DRY_RUN && echo "[DRY RUN]" || awk '/^## /{flag=1;next}/^$/{flag=0}flag' CHANGELOG.md | awk 'NR>1')


head -n -1 is GNU-specific; on macOS/BSD head this errors, which will break release PR creation on developer machines. Consider replacing this with a portable approach (e.g., using sed to drop the last line) or avoid needing to trim with head -n -1.

Copilot · 2026-02-12T00:37:41Z

pkg/foo_test.go

+
+	stdout := os.Stdout
+	os.Stdout = w
+
+	PrintFoo()
+
+	w.Close()
+
+	os.Stdout = stdout
+


This test mutates the global os.Stdout without a defer/t.Cleanup restore, so any early failure (or panic) can leak the redirected stdout into subsequent tests. Also, the pipe fds aren’t consistently closed via defer (e.g., r is never closed). Use t.Cleanup/defer to restore os.Stdout and close both ends of the pipe reliably.

Suggested change

stdout := os.Stdout

os.Stdout = w

PrintFoo()

w.Close()

os.Stdout = stdout

defer func() {

_ = r.Close()

}()

stdout := os.Stdout

os.Stdout = w

t.Cleanup(func() {

os.Stdout = stdout

})

defer func() {

_ = w.Close()

}()

PrintFoo()

w.Close()

Copilot · 2026-02-12T00:37:42Z

.github/workflows/release.yml

+  push:
+    tags:
+      - 'v*.*.*'
+


The documented release flow supports optional suffixes like alpha.1/rc.2, but the release workflow only triggers on tags matching v*.*.* (no prerelease suffix). Either expand the tag trigger to include prerelease patterns or clarify in docs/scripts that prerelease tags won’t run the release workflow.

Copilot · 2026-02-12T00:37:42Z

Makefile

+clean:
+	rm -f $(COVERAGE_FILE)
+
+release:


make release will run even if VERSION is unset, which would try to create/push a v tag. Add a guard that fails with a clear message when VERSION is missing (e.g., require VERSION to be non-empty before tagging).

Suggested change

release:

release:

@if [ -z "$(VERSION)" ]; then \

echo "ERROR: VERSION is not set. Usage: make release VERSION=x.y.z"; \

exit 1; \

fi

Copilot · 2026-02-12T00:37:42Z

README.md

+## 🚀 Release Automation
+
+### Prerequisites
+- [git-chglog](https://github.com/git-chglog/git-chglog) must be installed for changelog generation.
+
+### Release Workflow
+
+1. **Automate the release process:**
+   ```bash
+   ./scripts/release.sh           # Real release flow
+   ./scripts/release.sh --dry-run # Preview actions only (no changes made)
+   ```
+   This script will:
+   - Ensure you are on the main branch and up to date
+   - Determine the next version automatically
+   - Generate and commit the changelog for the new version
+   - Create a branch named `release/v<version>` from main
+   - Push the release branch to the remote
+   - Open a PR to main with the changelog as the PR body (requires GitHub CLI)
+


Release docs mention installing git-chglog but don’t mention that the repo needs a .chglog/config.yml (and possibly templates) for ./scripts/release.sh to work. Either add that config to the repo or update this section to document where the config lives/how to generate it.

scripts/next_version.sh

gbrennon added 6 commits February 10, 2026 00:35

defining go.mod file for forging_foundation project

1e97c92

defining the .github workflows for CI and release processes.

cbcf6d7

defining Makefile foor this project

f6e4c66

Makefile automates common tasks such as: - testing the codebase - generating code coverage reports - enforcing minimum coverage thresholds - cleaning up generated files - tagging releases

pkg dir the code

2f661a2

README.md created with initial content for the ForgingFoundation project

1ed2ec5

Including an overview, testing instructions, contributor guidelines and release automation workflow.

Implmenting scripts

926c40d

Those scripts will be used to automated the release process

gbrennon self-assigned this Feb 10, 2026

Copilot AI review requested due to automatic review settings February 10, 2026 03:55

Copilot started reviewing on behalf of gbrennon February 10, 2026 03:56 View session

Copilot AI reviewed Feb 10, 2026

View reviewed changes

gbrennon and others added 9 commits February 10, 2026 01:14

implementing Foo function so CI/CD doesnt fail

ceb3be3

Update README.md

85d05c4

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .github/workflows/release.yml

236bfc0

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update scripts/release.sh

5061b68

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update README.md

2c76ad4

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .github/workflows/ci.yml

e244232

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'chore/starting-golang-project' of github.com:forging-bl…

44b9ba5

…ocks-org/forging_foundation into chore/starting-golang-project

Update Makefile

5343a16

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

gbrennon requested a review from Copilot February 12, 2026 00:32

Update scripts/release.sh

fa9aac5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot started reviewing on behalf of gbrennon February 12, 2026 00:32 View session

gbrennon and others added 3 commits February 11, 2026 21:32

Update README.md

c2a8fa8

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Adjusting CHANGELOG_BODY

46f0664

Merge branch 'chore/starting-golang-project' of github.com:forging-bl…

2aa7102

…ocks-org/forging_foundation into chore/starting-golang-project

Copilot AI reviewed Feb 12, 2026

View reviewed changes

Improving release scripts for better dry-run support

cb18cb9

gbrennon merged commit 5565068 into main Feb 12, 2026
1 check passed

gbrennon deleted the chore/starting-golang-project branch February 12, 2026 00:43


		$DRY_RUN \|\| git push origin "$BRANCH"

		CHANGELOG_BODY=$($DRY_RUN && echo "[DRY RUN]" \|\| awk '/^## /{flag=1;next}/^$/{flag=0}flag' CHANGELOG.md \| awk 'NR>1')

-release:
+release:
+	@if [ -z "$(VERSION)" ]; then \
+		echo "ERROR: VERSION is not set. Usage: make release VERSION=x.y.z"; \
+		exit 1; \
+	fi

Conversation

gbrennon commented Feb 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants