https://github.com/skaldarnar/gh-terasology

A Terasology-specific extension for GitHub CLI
https://github.com/skaldarnar/gh-terasology

gh-extension

Last synced: about 2 months ago
JSON representation

A Terasology-specific extension for GitHub CLI

• Host: GitHub
• URL: https://github.com/skaldarnar/gh-terasology
• Owner: skaldarnar
• Created: 2021-09-09T18:49:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-29T20:23:22.000Z (over 2 years ago)
• Last Synced: 2024-11-13T13:57:17.901Z (about 2 months ago)
• Topics: gh-extension
• Language: Go
• Homepage:
• Size: 3.84 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gh-terasology - GitHub CLI extension for Terasology

This is a proof-of-concept [extension](https://github.blog/2021-08-24-github-cli-2-0-includes-extensions/) for `gh`, the GitHub CLI tool.

The concept of those extensions is quite simple, `gh` basically acts as plug-in manager and allows to call an executable as extension.

See [Creating GitHub CLI Extensions](https://docs.github.com/en/github-cli/github-cli/creating-github-cli-extensions) for more details.

The **`terasology` extension** is a [precompiled Go extension](https://github.com/cli/gh-extension-precompile).

## Getting Started

You can find more information on how to install and use extensions in general under [Using GitHub CLI Extensions](https://docs.github.com/en/github-cli/github-cli/using-github-cli-extensions).

To test this extension, you can easily install it via 

```

gh extension install skaldarnar/gh-terasology

```

## Usage

As this extensions is a proof-of-concept for testing out the capabilities of `gh` extensions for the use with Terasology there's not much to find here yet.

## Contributing

This extension is being build on [Go](https://go.dev/).

For local development make sure that you [download and install Go](https://go.dev/doc/install) for your platform.

**I'm a crazy person trying to force functional style onto everything, so you'll need the cutting edge [Go 1.18 Beta 1](https://go.dev/blog/go1.18beta1) or later with support for generics.**

For any changes to take effect the extension has to be compiled into a self-contained executable.

This is done by simply running :

```

go build

```

You can install the extension locally from source by running

```

gh extension install .

``` 

It will automatically update whenever the executable is rebuild.

No need to re-install over and over again.

## Roadmap

- assemble ready-made _changelogs_ for releases of Terasology

- _multi-repo management_, e.g., to update common configurations (settings, topics, ...)

- _release management_, e.g., automatically perform actions required for game or module releases

- _workspace management_, e.g., pinning of repository state, checkout by date, ...