Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
babarot committed Mar 18, 2023
1 parent 3eb1915 commit 56337c5
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions docs/configuration/package/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,24 +89,30 @@ Limit fetching to the specified number of commits from the tip of each remote br

### as

Type | Default
---|---
string | `""`
Key | Type | Default
---|---|---
gh-extension | Object | `null`

Available arguments:

- gh-extension
Change the installation behavior of the packages based on specified package type. In current afx, all packages are based on where it's hosted e.g. `github`. Almost all cases are not problem on that but some package types (such as "brew" or "gh extension") will be able to do more easily if there is a dedicated parameters to install the packages. In this `as` section, it expands more this installation method. Some of package types (especially "brew") will be coming soon in near future.

=== "gh-extension"

Install a package as [gh extension](https://github.blog/2023-01-13-new-github-cli-extension-tools/). Officially gh extensions can be installed with `gh extension install owern/repo` command ([guide](https://cli.github.com/manual/gh_extension_install)) but it's difficult to manage what we downloaded as code. In afx, by handling them as the same as other packages, it allows us to codenize them.

Key | Type | Default
---|---|---
name | string | (required)
rename-to | string | `""`

```yaml
- name: dlvhdr/gh-dash
description: A beautiful CLI dashboard for GitHub
owner: dlvhdr
repo: gh-dash
as: gh-extension
- name: yusukebe/gh-markdown-preview
description: GitHub CLI extension to preview Markdown looks like GitHub.
owner: yusukebe
repo: gh-markdown-preview
as:
gh-extension:
name: gh-markdown-preview
rename-to: gh-md # markdown-preview is long so rename it to shorten.
```

### release.name
Expand Down

0 comments on commit 56337c5

Please sign in to comment.