Skip to content

Releases: marcuwynu23/git-rndocs

Release list

v1.0.0

Choose a tag to compare

@github-actions github-actions released this 06 Jul 18:42

Release Notes

Version

v1.0.0

Release Date

2026-07-06


Features

  • Add version command to root command and update Execute function
  • Add version command to print the version number
  • Add make link and make unlink targets for symlink to C:/Bin/tools
  • **templates:**Add minimal.md template file
  • **templates:**Add github.md template file
  • **templates:**Add default.md template file
  • **cmd:**Implement release command with upload, draft, and prerelease flags
  • **cmd:**Implement config command with --get support
  • **cmd:**Implement init command for project scaffolding
  • **cmd:**Implement validate command for repo and config checks
  • **cmd:**Implement preview command for terminal output
  • **cmd:**Implement generate command with all flags
  • **cmd:**Create root command with sub-command registration
  • **app:**Implement application orchestrator with Generate, Preview, Validate, Init, and Release
  • **git:**Implement GoGitRepo with tag detection, commit iteration, diff stats, and contributor extraction
  • **output:**Implement Writer with dry-run, overwrite protection, and GitHub release support
  • **github:**Implement GitHub Release creation via CLI and REST API
  • **releasenotes:**Implement release notes Generator with tag iteration and single-version support
  • **markdown:**Implement professional Markdown release notes builder
  • **template:**Implement template engine with default, github, and minimal built-in templates
  • **contributors:**Define Contributor struct and Collect function with sorting
  • **stats:**Define Statistics struct and Collect function
  • **parser:**Implement conventional commit parsing with footers, issues, PRs, and categorization
  • **config:**Implement Config struct, LoadConfig, InitConfig, and directory scaffolding
  • **git:**Define Repository interface and Commit, Tag, DiffStats types
  • Initial commit

Bug Fixes

  • Pass context to GitHub release creation in Writer methods
  • Pass context to output writer in Generate and Release methods
  • Use absolute paths for NSIS installer output files
  • Update NSIS installer commands to use absolute paths for binaries
  • Update version determination logic in generateSingle function
  • Update Execute function to pass version variable
  • Fall back to copy when symlink requires admin on Windows
  • Use PowerShell for Windows link/unlink targets (works in Git Bash, cmd, pwsh)
  • Remove -race flag from test targets (fails on Windows without CGO)
  • Make build OS-aware — appends .exe on Windows automatically

Documentation

  • Add templates for rndocs
  • Rename GUIDE.md to USER-GUIDE.md and update references
  • Add comprehensive user guide and link from README
  • Expand what-is section with what/why/philosophy
  • Update FUNDING.yml with correct PayPal link and remove GitHub funding reference
  • Add CODE_OF_CONDUCT, SECURITY, PR/issue templates, FUNDING, and link CoC from CONTRIBUTING
  • Add CONTRIBUTING.md with developer guide, Makefile reference, and coding standards
  • Reorder title and logo section in README.md for clarity
  • Add Apache 2.0 license
  • Add centered title section with logo and badges
  • Fix table separator column count
  • Add auto-changelog comparison column to table
  • Update license to Apache 2.0 with summary and add sign-off message
  • Add table of contents to README
  • Add what-is, use cases, benefits, and comparison table to README
  • Add README.md with installation, usage, commands, and architecture

Refactoring

  • Move installer.nsi to installers folder

Build

  • Add .git-rndocs.yaml
  • Add version variable to Makefile for build process

CI/CD

  • Set fetch-depth to 0 for full history in checkout step
  • Add release notes generation and upload to GitHub Release
  • Consolidate Windows binary and NSIS Installer build steps
  • Update build commands in release.yml to set version variable for Windows, Linux, and macOS
  • Add multi-platform release workflow with NSIS installer and deb package
  • **github:**Add release-notes workflow for auto-generated release notes
  • **github:**Add release workflow using GoReleaser
  • **github:**Add CI workflow for build and test on ubuntu, windows, macos
  • **release:**Add GoReleaser configuration for multi-platform builds
  • **config:**Add .git-rndocs.yaml default configuration file

Tests

  • **git:**Add integration tests for Open, Tags, CommitsBetween, DiffStats, Contributors, DetachedHead
  • **markdown:**Add tests for BuildMarkdown, formatCommit, breaking changes, stats
  • **template:**Add tests for Render, GetBuiltin, BuildRenderData, unknown template
  • **contributors:**Add tests for Collect with sorting, single author, empty, dedup
  • **stats:**Add tests for Collect with categorized commits and empty input
  • **parser:**Add tests for ParseCommit, CategorizeCommits, DisplayName, footers, PRs
  • **config:**Add tests for DefaultConfig, LoadConfig, InitConfig, CreateDefaultDirectories

Maintenance

  • Move installer.nsi to installers/ folder
  • Create main.go entry point
  • Add Makefile with build, test, lint, clean targets
  • Add .gitignore for Go projects
  • **deps:**Bump golang.org/x/net

Contributors

  • Mark Wayne Buncaras Menorca (77 commits)
  • dependabot[bot] (1 commits)
  • Mark Wayne Menorca (1 commits)