Skip to content

RELEASE.md

Latest commit

 

History

History
68 lines (45 loc) · 1.98 KB

RELEASE.md

File metadata and controls

68 lines (45 loc) · 1.98 KB
Raw

Release Strategy for LazyNX

This document outlines our release strategy for packages in this repository.

Release Philosophy

Projects Setup

  • nxlsclient - Go library for communicating with the Nx Language Server
  • lazynx - Terminal UI application for managing Nx workspaces

How Releases Work

Automated Release Process

Releases are manually trigged but automatically executed using a github action pipeline:

  1. A GitHub Action checks for new changes in the projects
  2. The action runs tests and linters to ensure quality
  3. If tests pass, nx release is executed to:
    • Determine the next version based on commit messages
    • Update version references
    • Generate a changelog
    • Create Git tags with the format {projectName}@v{version}
    • Create a GitHub release
  4. For the nxlsclient library, the module is published to pkg.go.dev

Viewing Release History

  • GitHub Releases: See the Releases page
  • Changelogs: Each project maintains its own CHANGELOG.md file

Release Tagging Strategy

Tags follow the format: {projectName}@v{version}

Examples:

  • nxlsclient@v0.1.0
  • lazynx@v0.2.3

For Go Module Users

The nxlsclient library can be imported as:

import "github.com/lazyengs/lazynx/pkg/nxlsclient"

You can use a specific version with:

go get github.com/lazyengs/lazynx/pkg/nxlsclient@v0.1.0

Troubleshooting

If you encounter issues with the release process:

  1. Check the GitHub Actions logs for errors
  2. Ensure all tests are passing
  3. Verify that your commit messages follow the Conventional Commits format
  4. Check that your go.mod file has the correct module path