Skip to content

Commit

Permalink
feat: preparing for first release
Browse files Browse the repository at this point in the history
  • Loading branch information
pspiagicw committed Aug 12, 2024
1 parent 3fd5479 commit 56916c9
Show file tree
Hide file tree
Showing 9 changed files with 107 additions and 42 deletions.
1 change: 1 addition & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
use flake
30 changes: 0 additions & 30 deletions .github/workflows/documentation.yaml

This file was deleted.

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
groom
build
.direnv

dist/
48 changes: 48 additions & 0 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# This is an example .goreleaser.yml file with some sensible defaults.
# Make sure to check the documentation at https://goreleaser.com

# The lines below are called `modelines`. See `:help modeline`
# Feel free to remove those if you don't want/need to use them.
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
# vim: set ts=2 sw=2 tw=0 fo=cnqoj

version: 1

before:
hooks:
# You may remove this if you don't use go modules.
- go mod tidy
# you may remove this if you don't need go generate
- go generate ./...

builds:
- env:
- CGO_ENABLED=0
goos:
- linux
- windows
- darwin
ldflags:
- -X main.VERSION={{ .Version }}

archives:
- format: tar.gz
# this name template makes the OS and Arch compatible with the results of `uname`.
name_template: >-
{{ .ProjectName }}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
# use zip for windows archives
format_overrides:
- goos: windows
format: zip

changelog:
sort: asc
filters:
exclude:
- "^docs:"
- "^test:"
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ command = "go fmt ./..."
# As opposed to executed directly
# Useful for shell features like globbing
[task.tags]
shell = "bash"
command = "ctags *.go"
# This becomes "bash -c 'ctags *.go'"
```
Expand Down
3 changes: 2 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased(v0.0.2)
## Unreleased(v0.1.1)

### Added

- Added the `shell` option to run the specified command in the shell.
- Added the `directory` option to change directory before executing a task.
- Help Printing.
- Added a `--simple` flag to task listing.
Expand Down
27 changes: 27 additions & 0 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions flake.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
description = "CLI configuration with vhs";

inputs = {
# Nixpkgs repository
nixpkgs.url = "github:nixos/nixpkgs/nixos-24.05";
};

outputs = {
self,
nixpkgs,
}: {
devShell.x86_64-linux = let
pkgs = import nixpkgs {system = "x86_64-linux";};
in
pkgs.mkShell {
buildInputs = [
pkgs.vhs
pkgs.gopls
pkgs.bashInteractive
pkgs.goreleaser
];
};
};
}
11 changes: 0 additions & 11 deletions groom.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,3 @@ command = "go fmt ./..."
[task.clean]
description = "Clean the repository"
command = "rm -rf ${build-dir}"

[task.install]
description = "Install the binary(Requires gox)"
command = "gox install ."
depends = [
"build"
]

[task.doc]
description = "Build documentation"
command = "docker run --rm -v ${pwd}:/work --user 1000:1000 pspiagicw/doc-generator"

0 comments on commit 56916c9

Please sign in to comment.