A (not-so-)spammy way to spread awareness

[nikolay]

Overview

Aqua is a great tool. It's much faster than asdf (even with the Rust replacement rtx), and safer, but it's not popular. As the repositories, which are supported, are in the standard registry, maybe an automated script to create an issue with the project, which suggests adding an installation with aqua (maybe even posting a small piece of suggested markdown to be included in the installation section.

Why is the proposal needed?

Bring more awareness and support for the fantastic tool.

[nikolay]

Here's an example: Boeing/config-file-validator#57

[suzuki-shunsuke]

Thank you for your suggestion.
Interesting.
We can create issues to repositories that aqua-registry is supporting by script.
We can add the installation guide to the issue description so that maintainers can copy and paste it to README easily.
I think it's not so difficult.

But I'm afraid that it may be spammy.
The script just creates a single issue, so maybe it's not so spammy. 🤔

[suzuki-shunsuke]

I wrote a template of issues.

Add the installation guide with aqua to the document

This issue was created automatically by script. For the detail, please see here.

Hi, thank you for your great project!

We suggest to add the installation guide with aqua to the document.
aqua is a declarative CLI Version Manager.
aqua has supported this tool, so you can install this tool with aqua.

aqua init # Create aqua.yaml
aqua g -i <package name> # Add this tool to aqua.yaml
aqua i # Install tools

For the detail of aqua, please see the official document.

We expect you can just copy and paste the following guide to your document.

---

Install with aqua

You can install this tool with aqua.

aqua g -i <package name> # Add this tool to aqua.yaml

---

Thank you.

[nikolay]

Maybe somehow we can split repositories among supporters and run a script that posts from our own accounts.

[suzuki-shunsuke]

Create repository lists

The list isn't perfect, but almost good.

git ls-files | grep -E "^pkgs/[^.]+/registry\.yaml$" | sed -E "s|^pkgs/([^./]+/[^./]+)[^.]*/registry\.yaml$|\1|" | sort -u

$ git ls-files | grep -E "^pkgs/[^.]+/registry\.yaml$" | sed -E "s|^pkgs/([^./]+/[^./]+)[^.]*/registry\.yaml$|\1|" | sort -u | wc -l
    1183

Create issues

• create_issues.sh
• repos.txt
• created_repos.txt
• body.md

#!/usr/bin/env bash

set -euo pipefail

echo "[INFO] Creating issues" >&2
while read -r repo; do
	if echo "$repo" | grep -f created_repos.txt > /dev/null; then
		echo "[INFO] Skipped creating an issue because it was already created to this repository  repo=$repo" >&2
		continue
	fi
	echo "[INFO] Creating an issue  repo=$repo" >&2
	sed "s|<package>|$repo|" body.md |
		gh -R "$repo" issue create \
			-F - \
			-t "Add the installation guide with aqua to the document"
	echo "$repo" >> created_repos.txt
done < repos.txt
echo "[INFO] Completed creating issues" >&2

[suzuki-shunsuke]

List only packages whose names are <repo owner>/<repo name>

git ls-files | grep -E "^pkgs/[^./]+/[^./]+/registry\.yaml$" | sed -E "s|^pkgs/(.*)/registry\.yaml$|\1|" | sort -u

[suzuki-shunsuke]

I created a repository. https://github.com/aquaproj/create-installation-guide-issues
And I created some issues with my OSS for testing.
It looks good.

$ ./create_issues.sh 
[INFO] Creating issues
[INFO] Creating an issue  repo=suzuki-shunsuke/ci-info url=https://github.com/suzuki-shunsuke/ci-info

Creating issue in suzuki-shunsuke/ci-info

https://github.com/suzuki-shunsuke/ci-info/issues/401
[INFO] Skipped creating an issue because it was already created to this repository  repo=suzuki-shunsuke/circleci-config-merge url=https://github.com/suzuki-shunsuke/circleci-config-merge
[INFO] Creating an issue  repo=suzuki-shunsuke/cmdx url=https://github.com/suzuki-shunsuke/cmdx

Creating issue in suzuki-shunsuke/cmdx

https://github.com/suzuki-shunsuke/cmdx/issues/538
[INFO] Completed creating issues

• Add the installation guide with aqua to the document suzuki-shunsuke/ci-info#401
• Add the installation guide with aqua to the document suzuki-shunsuke/cmdx#538

[suzuki-shunsuke]

Before creating issues to all repositories, we can create only 10 ~ 20 issues and check the reaction first.

[suzuki-shunsuke]

List of Issues

https://github.com/search?q=is%3Aissue%20author%3Asuzuki-shunsuke%20%22Add%20the%20installation%20guide%20with%20aqua%20to%20the%20document%22%20in%3Atitle&type=issues

[suzuki-shunsuke]

I created 13 issues first.

• Songmu/ecschedule
• fujiwara/lambroll
• goccy/bigquery-emulator
• hirosassa/ksnotify
• hirosassa/tfcmt-gitlab
• int128/kauthproxy
• k1LoW/runn
• kayac/ecspresso
• ryoppippi/zigchat
• siderolabs/conform
• siderolabs/talos
• takumin/gjson
• takumin/gyaml

[suzuki-shunsuke]

Create GitHub Issues by script

Hi, thank you for your great project!
We created GitHub Issues to your project by script.
We are sorry about that if you feel issues are noisy, spammy, or uncomfortable 🙇‍♂️

aqua is a declarative CLI Version Manager written in Go.
You can install command line tools and manage their versions with declarative YAML configuration files aqua.yaml.
aqua is similar to asdf, but has various additional features such as Renovate Support, Checksum Verification, and Lazy Install.
aqua supports over 1,200 packages! For the detail, please see the official document.

If you have any feedbacks on the issue creation, please comment!
If you want to improve the script or issue template, please send pull requests to https://github.com/aquaproj/create-installation-guide-issues .

• script
• template