Skip to content

Commit

Permalink
fix: Fix release target and improve docs (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
yufeiminds authored May 9, 2023
1 parent 7564976 commit 66922a1
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 20 deletions.
12 changes: 6 additions & 6 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ dockers:
- --label=org.opencontainers.image.title={{ .ProjectName }}
- --label=org.opencontainers.image.description={{ .ProjectName }}
- --label=org.opencontainers.image.url=https://guance.io
- --label=org.opencontainers.image.source=https://github.com/GuanceCloud/guance
- --label=org.opencontainers.image.source=https://github.com/GuanceCloud/guance-cli
- --label=org.opencontainers.image.version={{ .Version }}
- --label=org.opencontainers.image.created={{ time "2006-01-02T15:04:05Z07:00" }}
- --label=org.opencontainers.image.revision={{ .FullCommit }}
Expand All @@ -86,7 +86,7 @@ dockers:
- --label=org.opencontainers.image.title={{ .ProjectName }}
- --label=org.opencontainers.image.description={{ .ProjectName }}
- --label=org.opencontainers.image.url=https://guance.io
- --label=org.opencontainers.image.source=https://github.com/GuanceCloud/guance
- --label=org.opencontainers.image.source=https://github.com/GuanceCloud/guance-cli
- --label=org.opencontainers.image.version={{ .Version }}
- --label=org.opencontainers.image.created={{ time "2006-01-02T15:04:05Z07:00" }}
- --label=org.opencontainers.image.revision={{ .FullCommit }}
Expand All @@ -108,8 +108,8 @@ nfpms:
- id: guance
maintainer: Guance Cloud <[email protected]>
vendor: Guance Cloud Inc.
description: guance is a programming language for Observability Data Pipeline.
homepage: https://guance.guance.io
description: Command-Line Toolkit for Guance Cloud
homepage: https://guance.io
license: MIT
formats:
- deb
Expand Down Expand Up @@ -211,7 +211,7 @@ brews:
# gitlab or gitea)
#
# Default depends on the client.
url_template: "https://github.com/GuanceCloud/guance/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
url_template: "https://github.com/GuanceCloud/guance-cli/releases/download/{{ .Tag }}/{{ .ArtifactName }}"

# Allows you to set a custom download strategy. Note that you'll need
# to implement the strategy and add it to your tap repository.
Expand All @@ -234,7 +234,7 @@ brews:

# Your app's homepage.
# Default is empty.
homepage: "https://guance.guance.io/"
homepage: "https://guance.io/"

# Template of your app's description.
# Default is empty.
Expand Down
13 changes: 13 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2023 Guance Cloud Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Guance Cloud CLI

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat&logo=github&color=2370ff&labelColor=454545)](http://makeapullrequest.com)
[![Go Report Card](https://goreportcard.com/badge/github.com/GuanceCloud/guance-cli)](https://goreportcard.com/report/github.com/GuanceCloud/guance-cli)
[![Downloads](https://img.shields.io/github/downloads/GuanceCloud/guance-cli/total.svg)](https://github.com/GuanceCloud/guance-cli/releases)

A command-line tool to help users interact with Guance Cloud.

![cover](./artwork/cover.png)
Expand All @@ -15,28 +19,38 @@ A command-line tool to help users interact with Guance Cloud.

## Installation

### Quickstart

**Linux**
### Mac OSX

```shell
curl -sL https://raw.githubusercontent.com/GuanceCloud/guance-cli/master/install.sh | bash
brew tap GuanceCloud/homebrew-tap
brew install GuanceCloud/tap/guance
```

See the [Release page](https://github.com/GuanceCloud/guance-cli/releases) to download the latest release for Linux.

**Mac OSX**
### Ubuntu or Debian

```shell
brew tap GuanceCloud/homebrew-tap
brew install GuanceCloud/tap/guance
echo "deb [trusted=yes] https://releases.guance.io/apt/ /" | sudo tee /etc/apt/sources.list.d/guance.list
sudo apt update
sudo apt install guance
```

**Windows**
### CentOS or RHEL

We are working in progress.
```shell
cat <<EOF | sudo tee /etc/yum.repos.d/guance.repo
[guance]
name=Guance Cloud Repo
baseurl=https://releases.guance.io/yum/
enabled=1
gpgcheck=0
EOF
sudo yum install -y guance
```

**Verify Installation**
### Binary
See the [release page](https://github.com/GuanceCloud/guance-cli/releases) to download the latest release.

### Verify Installation

```shell
guance version
Expand All @@ -55,4 +69,3 @@ This [Contribution Guidelines](https://guance.io/contribution-guide/) document c
## License

This repository is licensed under the [Apache 2.0 License](./LICENSE).

2 changes: 1 addition & 1 deletion cmd/guance/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func newVersionCmd() *cobra.Command {
Use: "version",
Short: "Print the version number of guance",
Run: func(cmd *cobra.Command, args []string) {
fmt.Printf("Guance v%s, commit %s, built at %s", version, commit, date)
fmt.Printf("Guance v%s, commit %s, built at %s\n", version, commit, date)
},
}
}
2 changes: 2 additions & 0 deletions specs/iac/import.spec.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Test import Guance resources from console exported file

The details of CLI usage can be found in [reference documentations](../../docs/references/guance_iac_import.md).

## Import Dashboard

* Run "guance iac import console -r dashboard -f ./dashboard.json -t terraform-module -o ./out"
Expand Down

0 comments on commit 66922a1

Please sign in to comment.