Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename aqua #4418

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .cmdx.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,30 @@ tasks:
short: i
description: install all packages
usage: install all packages
script: aqua -c aqua-all.yaml i --test
script: clivm -c clivm-all.yaml i --test
- name: test
short: t
description: test
usage: test
script: aqua i --test
script: clivm i --test
- name: exec
short: x
description: exec with aqua-all.yaml
usage: exec with aqua-all.yaml
script: AQUA_CONFIG=aqua-all.yaml aqua exec -- {{._builtin.args_string}}
description: exec with clivm-all.yaml
usage: exec with clivm-all.yaml
script: CLIVM_CONFIG=clivm-all.yaml clivm exec -- {{._builtin.args_string}}
- name: which
short: w
description: aqua which with aqua-all.yaml
usage: aqua which with aqua-all.yaml
script: "AQUA_CONFIG=aqua-all.yaml aqua which {{.package}}"
description: clivm which with clivm-all.yaml
usage: clivm which with clivm-all.yaml
script: "CLIVM_CONFIG=clivm-all.yaml clivm which {{.package}}"
args:
- name: package
required: true
- name: generate
short: g
description: aqua generate with aqua-all.yaml
usage: aqua generate with aqua-all.yaml
script: aqua -c aqua-all.yaml g
description: clivm generate with clivm-all.yaml
usage: clivm generate with clivm-all.yaml
script: clivm -c clivm-all.yaml g
- name: release
short: r
description: release the new version
Expand Down
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/Bug_Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ e.g. `suzuki-shunsuke/github-comment`

-

## aqua version
## clivm version

Please use the latest version.

```console
$ aqua -v
$ clivm -v

```

Expand All @@ -27,14 +27,14 @@ $ aqua -v

## How to reproduce

- aqua.yaml
- clivm.yaml
- executed command and output

> aqua.yaml should be not partial but complete configuration.
> clivm.yaml should be not partial but complete configuration.
> Please remove unneeded configuration to reproduce the issue.

```yaml
# aqua.yaml
# clivm.yaml
```

```console
Expand All @@ -43,7 +43,7 @@ $

## Debug Output

Please set the environment variable `AQUA_LOG_LEVEL=debug` and run aqua and tell us the debug output.
Please set the environment variable `CLIVM_LOG_LEVEL=debug` and run clivm and tell us the debug output.

```console
$
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Issue of aqua
url: https://github.com/aquaproj/aqua/issues
about: Please report issues about aqua itself
- name: Issue of clivm
url: https://github.com/clivm/clivm/issues
about: Please report issues about clivm itself
6 changes: 3 additions & 3 deletions .github/workflows/actionlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ jobs:
default:
runs-on: ubuntu-latest
env:
AQUA_CONFIG: aqua-ci.yaml
CLIVM_CONFIG: clivm-ci.yaml
steps:
- uses: actions/checkout@v3
- uses: aquaproj/aqua-installer@v1.0.0
- uses: clivm/clivm-installer@v1.0.0
with:
aqua_version: v1.14.0
clivm_version: v1.14.0
- run: actionlint -ignore "duplicate value"
2 changes: 1 addition & 1 deletion .github/workflows/json-schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ jobs:
with:
node-version: "16"

- run: curl --fail -O -L "https://raw.githubusercontent.com/aquaproj/aqua/main/json-schema/registry.json"
- run: curl --fail -O -L "https://raw.githubusercontent.com/clivm/clivm/main/json-schema/registry.json"
- run: npm install -g ajv-cli
- run: ajv --spec=draft2020 -s registry.json -d registry.yaml
52 changes: 26 additions & 26 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ jobs:
generate-registry:
runs-on: ubuntu-latest
env:
AQUA_CONFIG: aqua-ci.yaml
CLIVM_CONFIG: clivm-ci.yaml
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3
- uses: aquaproj/aqua-installer@v1.0.0
- uses: clivm/clivm-installer@v1.0.0
with:
aqua_version: v1.14.0
clivm_version: v1.14.0
- run: bash generate-registry.sh
- run: git add .
- run: git --no-pager diff --cached
- run: |
if ! git diff --cached --exit-code; then
echo 'Please run "bash generate-registry.sh"' >&2
echo 'https://github.com/aquaproj/aqua-registry/blob/main/CONTRIBUTING.md#run-generate-registrysh-to-update-reigstryyaml' >&2
echo 'https://github.com/clivm/clivm-registry/blob/main/CONTRIBUTING.md#run-generate-registrysh-to-update-reigstryyaml' >&2
exit 1
fi

Expand Down Expand Up @@ -56,61 +56,61 @@ jobs:
- uses: actions/checkout@v3

# Disable cache
# The cache size is so huge that it takes a long time for `cache ~/.aqua` and `Post cache ~/.aqua`
# e.g. https://github.com/aquaproj/aqua-registry/runs/4426879327
# The cache size is so huge that it takes a long time for `cache ~/.clivm` and `Post cache ~/.clivm`
# e.g. https://github.com/clivm/clivm-registry/runs/4426879327
#
# - name: cache ~/.aqua
# - name: cache ~/.clivm
# uses: actions/cache@v2
# with:
# path: |
# ~/.aqua/pkgs
# ~/.aqua/registries
# key: v5-${{ runner.os }}-${{ hashFiles('registry.yaml') }}-${{ hashFiles('aqua-all.yaml') }}
# ~/.clivm/pkgs
# ~/.clivm/registries
# key: v5-${{ runner.os }}-${{ hashFiles('registry.yaml') }}-${{ hashFiles('clivm-all.yaml') }}
# restore-keys: |
# v5-${{ runner.os }}-${{ hashFiles('registry.yaml') }}-
# v5-${{ runner.os }}-

- uses: aquaproj/aqua-installer@v1.0.0
- uses: clivm/clivm-installer@v1.0.0
with:
aqua_version: v1.14.0
clivm_version: v1.14.0
env:
AQUA_CONFIG: aqua-ci.yaml
CLIVM_CONFIG: clivm-ci.yaml

- uses: actions/setup-go@v3
with:
go-version: "1.18.3"

- name: run ci-info and update environment variables
shell: bash
# TODO Run the command without `aqua exec`.
# TODO Run the command without `clivm exec`.
# We don't know the cause, but `ci-info run | sed -E "s/^export //" >> "$GITHUB_ENV"` doesn't work on Windows.
# So we run ci-info via `aqua exec`.
run: aqua exec -- ci-info run | sed -E "s/^export //" >> "$GITHUB_ENV"
# So we run ci-info via `clivm exec`.
run: clivm exec -- ci-info run | sed -E "s/^export //" >> "$GITHUB_ENV"
env:
AQUA_CONFIG: aqua-ci.yaml
CLIVM_CONFIG: clivm-ci.yaml
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: install packages for testing
shell: bash
run: |
if grep -E "target:" "$CI_INFO_TEMP_DIR/labels.txt" > /dev/null 2>&1; then
grep -E "target:" "$CI_INFO_TEMP_DIR/labels.txt" | sed "s|^target:\(.*\)| - import: pkgs/\1/pkg.yaml|" >> aqua-ci.yaml
grep -E "target:" "$CI_INFO_TEMP_DIR/labels.txt" | sed "s|^target:\(.*\)| - import: pkgs/\1/pkg.yaml|" >> clivm-ci.yaml
fi
if grep -E "^pkgs/.*\.yaml" < "$CI_INFO_TEMP_DIR/pr_all_filenames.txt" > /dev/null 2>&1; then
grep -E "^pkgs/.*\.yaml" < "$CI_INFO_TEMP_DIR/pr_all_filenames.txt" | sed "s/registry\.yaml/pkg.yaml/" | sort -u | sed "s/^/ - import: /" >> aqua-ci.yaml
grep -E "^pkgs/.*\.yaml" < "$CI_INFO_TEMP_DIR/pr_all_filenames.txt" | sed "s/registry\.yaml/pkg.yaml/" | sort -u | sed "s/^/ - import: /" >> clivm-ci.yaml
fi
echo "[INFO] aqua-ci.yaml" >&2
cat aqua-ci.yaml >&2
echo "[INFO] clivm-ci.yaml" >&2
cat clivm-ci.yaml >&2

- run: echo "AQUA_GOOS=$AQUA_GOOS" >> "$GITHUB_ENV"
- run: echo "CLIVM_GOOS=$CLIVM_GOOS" >> "$GITHUB_ENV"
shell: bash
if: matrix.env.goos != ''
env:
AQUA_GOOS: ${{ matrix.env.goos }}
- run: echo "AQUA_GOARCH=$AQUA_GOARCH" >> "$GITHUB_ENV"
CLIVM_GOOS: ${{ matrix.env.goos }}
- run: echo "CLIVM_GOARCH=$CLIVM_GOARCH" >> "$GITHUB_ENV"
shell: bash
if: matrix.env.goarch != ''
env:
AQUA_GOARCH: ${{ matrix.env.goarch }}
- run: aqua -log-level debug -c aqua-ci.yaml i --test
CLIVM_GOARCH: ${{ matrix.env.goarch }}
- run: clivm -log-level debug -c clivm-ci.yaml i --test
shell: bash
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
aqua-test.yaml
aqua.yaml
clivm-test.yaml
clivm.yaml
.DS_Store
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

About how to write [registry.yaml](registry.yaml), please see [Registry Configuration](https://aquaproj.github.io/docs/reference/registry-config).
About how to write [registry.yaml](registry.yaml), please see [Registry Configuration](https://clivm.github.io/docs/reference/registry-config).

## Add packages

Expand Down Expand Up @@ -28,7 +28,7 @@ $ bash generate-registry.sh

## Scaffold configuration

aqua >= v1.14.0 is required.
clivm >= v1.14.0 is required.

```console
$ bash scaffold.sh <package name>
Expand Down Expand Up @@ -96,7 +96,7 @@ We test the registry in CI on the above environments by GitHub Actions' build ma
:warning: The author [@suzuki-shunsuke](https://github.com/suzuki-shunsuke) isn't familiar with Rust. If you have any opinion, please let us know.

- linux: use the asset for not `gnu` but `musl` if both of them are supported
- ref: https://github.com/aquaproj/aqua-registry/pull/2153#discussion_r805116879
- ref: https://github.com/clivm/clivm-registry/pull/2153#discussion_r805116879
- windows: use the asset for not `gnu` but `msvc` if both of them are supported
- ref: https://rust-lang.github.io/rustup/installation/windows.html

Expand All @@ -118,7 +118,7 @@ replacements:

## Test multiple versions

If the package has the field [version_overrides](https://aquaproj.github.io/docs/reference/registry-config#version_constraint-version_overrides),
If the package has the field [version_overrides](https://clivm.github.io/docs/reference/registry-config#version_constraint-version_overrides),
please add not only the latest version but also old versions in `pkg.yaml` to test if old versions can be installed properly.

e.g. [pkg.yaml](pkgs/scaleway/scaleway-cli/pkg.yaml) [registry.yaml](pkgs/scaleway/scaleway-cli/registry.yaml)
Expand All @@ -143,11 +143,11 @@ packages:
## How to test in your localhost

```console
$ cp aqua.yaml.tmpl aqua.yaml
$ vi aqua.yaml # Add tested packages
$ aqua i --test
$ cp clivm.yaml.tmpl clivm.yaml
$ vi clivm.yaml # Add tested packages
$ clivm i --test
```

## Change `GOOS` and `GOARCH` for testing

Please see https://aquaproj.github.io/docs/reference/change-os-arch-for-test
Please see https://clivm.github.io/docs/reference/change-os-arch-for-test
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# aqua-registry
# clivm-registry

[![Build Status](https://github.com/aquaproj/aqua-registry/workflows/test/badge.svg)](https://github.com/aquaproj/aqua-registry/actions) [![GitHub last commit](https://img.shields.io/github/last-commit/aquaproj/aqua-registry.svg)](https://github.com/aquaproj/aqua-registry) [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/aquaproj/aqua-registry/main/LICENSE)
[![Build Status](https://github.com/clivm/clivm-registry/workflows/test/badge.svg)](https://github.com/clivm/clivm-registry/actions) [![GitHub last commit](https://img.shields.io/github/last-commit/clivm/clivm-registry.svg)](https://github.com/clivm/clivm-registry) [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/clivm/clivm-registry/main/LICENSE)

[aqua](https://github.com/aquaproj/aqua)'s Standard Registry
[clivm](https://github.com/clivm/clivm)'s Standard Registry

## How to use

[Example](https://github.com/suzuki-shunsuke/my-aqua-config/blob/main/aqua.yaml)
[Example](https://github.com/suzuki-shunsuke/my-clivm-config/blob/main/clivm.yaml)

aqua.yaml
clivm.yaml

```yaml
registries:
- type: standard
ref: v3.3.0 # renovate: depName=aquaproj/aqua-registry
ref: v3.3.0 # renovate: depName=clivm/clivm-registry
```

## Search packages from the Standard Registry by the command `aqua g`
## Search packages from the Standard Registry by the command `clivm g`

Please add the Standard Registry to your aqua.yaml's registries, and run `aqua g`.
Please add the Standard Registry to your clivm.yaml's registries, and run `clivm g`.

```yaml
registries:
- type: standard
ref: v3.3.0 # renovate: depName=aquaproj/aqua-registry
ref: v3.3.0 # renovate: depName=clivm/clivm-registry
```

`aqua g` launches the interactive UI and you can search the package by fuzzy search.
`clivm g` launches the interactive UI and you can search the package by fuzzy search.

```console
newrelic/newrelic-cli (standard) (newrelic) ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
Expand Down Expand Up @@ -54,10 +54,10 @@ registries:

## Request for new packages

Please check [registry.yaml](https://github.com/aquaproj/aqua-registry/blob/main/registry.yaml) or search packages by `aqua g` command.
Please check [registry.yaml](https://github.com/clivm/clivm-registry/blob/main/registry.yaml) or search packages by `clivm g` command.
If the packages you want aren't found, please create issues or send pull requests!

By adding various packages to the standard registry, aqua becomes more useful and attractive.
By adding various packages to the standard registry, clivm becomes more useful and attractive.
We need your contribution!

## How to contribute
Expand All @@ -69,30 +69,30 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md)
You can get over 400 packages in your laptop! By Lazy Install, packages aren't installed until they are really needed.

1. Check out this repository
1. Add [aqua-all.yaml](aqua-all.yaml) to the environment variable `AQUA_GLOBAL_CONFIG`
1. Run `aqua i -l -a`
1. Add [clivm-all.yaml](clivm-all.yaml) to the environment variable `CLIVM_GLOBAL_CONFIG`
1. Run `clivm i -l -a`

```console
$ git clone https://github.com/aquaproj/aqua-registry
$ export AQUA_GLOBAL_CONFIG="$PWD/aqua-registry/aqua-all.yaml:$AQUA_GLOBAL_CONFIG"
$ aqua i -l -a
$ git clone https://github.com/clivm/clivm-registry
$ export CLIVM_GLOBAL_CONFIG="$PWD/clivm-registry/clivm-all.yaml:$CLIVM_GLOBAL_CONFIG"
$ clivm i -l -a
```

Set up cron to checkout the repository and run `aqua i -l -a` periodically, you can update packages automatically.
Set up cron to checkout the repository and run `clivm i -l -a` periodically, you can update packages automatically.

If you want to change some packages' version, please override them by the other configuration file.

```console
$ export AQUA_GLOBAL_CONFIG="<Other aqua.yaml>:$PWD/aqua-all.yaml:$AQUA_GLOBAL_CONFIG"
$ export CLIVM_GLOBAL_CONFIG="<Other clivm.yaml>:$PWD/clivm-all.yaml:$CLIVM_GLOBAL_CONFIG"
```

## Change Log

Please see [Releases](https://github.com/aquaproj/aqua-registry/releases).
Please see [Releases](https://github.com/clivm/clivm-registry/releases).

## Contributors

[![contributors](https://contrib.rocks/image?repo=aquaproj/aqua-registry)](https://github.com/aquaproj/aqua-registry/graphs/contributors)
[![contributors](https://contrib.rocks/image?repo=clivm/clivm-registry)](https://github.com/clivm/clivm-registry/graphs/contributors)

## License

Expand Down
9 changes: 9 additions & 0 deletions clivm-all.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
registries:
- name: standard
type: local
path: registry.yaml
packages:
- import: pkgs/*/*/pkg.yaml
- import: pkgs/*/*/*/pkg.yaml
- import: pkgs/*/*/*/*/*/pkg.yaml # golang.org/x/perf/cmd/benchstat
# Don't add packages here.
7 changes: 7 additions & 0 deletions clivm-ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
registries:
- name: standard
type: local
path: registry.yaml
packages:
- name: suzuki-shunsuke/ci-info@v2.0.3
- name: rhysd/actionlint@v1.6.14
Loading