goautomate

README

GoAutomate

goautomate is a Go tool that automates the process of checking and updating Go versions in your projects. It can detect the current Go version from various file types, compare it with the latest available version, and download the newest version if an update is available.

Features

• Detect current Go version from various file types (Dockerfile, go.mod, JSON configs, etc.)
• Check for the latest available Go version
• Download the latest Go version if an update is available
• Support for different operating systems and architectures

Installation

To install goautomate, use the following command:

go install github.com/Nicconike/goautomate/cmd/goautomate@latest

Usage

Basic Usage

goautomate -file <path-to-file>

This will check the specified file for the current Go version, compare it with the latest available version, and download the new version if an update is available.

Command-line Options

• -file: Path to the file containing the current Go version
• -version or -v: Directly specify the current Go version
• -os: Target operating system (windows, linux, macOS[darwin])
• -arch: Target architecture (386[x86], amd64[x86-64], arm64, armv6l[armv6])

Examples

1. Get version from a Dockerfile:

   goautomate -file Dockerfile
   

   

2. Get version from go.mod:

   goautomate -file go.mod
   

   

3. Specify version directly:

   goautomate -version 1.16.5
   

   

4. Download for a specific OS and architecture:

   goautomate -file version.json -os linux -arch arm64
   

   

Supported File Types

goautomate can extract Go versions from various file types, including:

• Dockerfile
• go.mod
• JSON configuration files
• Plain text files with version information

The tool uses various patterns to detect Go versions, making it flexible for different project setups.

Missing any file types you expected to see? Let me know via discussions.

Contributing

Contributions to goautomate are welcome! Please feel free to submit a Pull Request.

License

GPLv3 License

Documentation

Overview

Package goautomate provides tools for automating Go version checks and downloads.

Do's: 1. Always check for errors returned by functions in this package. 2. Use GetLatestVersion() to fetch the most recent Go version information. 3. Specify the correct target OS and architecture when using DownloadGo(). 4. Ensure you have necessary permissions to download and write files. 5. Define Go version in your project files using one of these formats:

• In go.mod: go 1.x
• In Dockerfile:
• - FROM golang:1.x.x
• - ENV GO_VERSION=1.x.x
• In other files:
• - go_version = "1.x.x"
• - GO_VERSION: 1.x.x
• - golang_version: "1.x.x"

6. Use the package to automate version checks in your CI/CD pipelines.

Don'ts: 1. Don't assume the latest version is always compatible with your project. 2. Avoid using this package to modify your system's Go installation directly. 3. Don't use this package in production environments without thorough testing. 4. Don't ignore version constraints specified in your go.mod file. 5. Avoid manually modifying files downloaded by this package. 6. Don't use non-standard formats for specifying Go versions in your project files.

Example usage:

latestVersion, err := goautomate.GetLatestVersion()
if err != nil {
    log.Fatal(err)
}

err = goautomate.DownloadGo(latestVersion, "linux", "amd64")
if err != nil {
    log.Fatal(err)
}

For more detailed information and advanced usage, refer to the README.md file.