Skip to content

Commit

Permalink
Merge pull request #37 from GrantBirki/main
Browse files Browse the repository at this point in the history
General Updates
  • Loading branch information
rneatherway committed Apr 26, 2023
2 parents 6ce4b4e + 31ee47d commit 476dca0
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 28 deletions.
16 changes: 9 additions & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ jobs:
name: Build
runs-on: macos-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Setup Go
uses: actions/setup-go@v2
uses: actions/setup-go@v4
with:
go-version: 1.18.1

- name: Build
uses: goreleaser/goreleaser-action@v2
uses: goreleaser/goreleaser-action@v4
with:
version: latest
args: --rm-dist --snapshot
Expand All @@ -29,11 +30,12 @@ jobs:
name: Test
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Setup Go
uses: actions/setup-go@v2
uses: actions/setup-go@v4
with:
go-version: 1.18.1

- name: Test
run: go test ./...
9 changes: 5 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@ jobs:
name: Release
runs-on: macos-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Setup Go
uses: actions/setup-go@v2
uses: actions/setup-go@v4
with:
go-version: 1.18.1

- name: Release
uses: goreleaser/goreleaser-action@v2
uses: goreleaser/goreleaser-action@v4
with:
version: latest
args: release --rm-dist
Expand Down
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# gh-slack

This project provides a means of archiving a Slack conversation or thread as markdown. For convenience it is installable as a `gh` extension.
[![CI](https://github.com/rneatherway/gh-slack/actions/workflows/ci.yml/badge.svg)](https://github.com/rneatherway/gh-slack/actions/workflows/ci.yml) [![Release](https://github.com/rneatherway/gh-slack/actions/workflows/release.yml/badge.svg)](https://github.com/rneatherway/gh-slack/actions/workflows/release.yml)

This project provides a means of archiving a Slack conversation or thread as markdown. For convenience it is installable as a `gh` extension.

## Installation

Expand All @@ -13,32 +14,28 @@ This project provides a means of archiving a Slack conversation or thread as mar

## Usage

```
Usage:
gh slack [OPTIONS] [Start]
Usage:
gh slack [OPTIONS] [Start]

Application Options:
-l, --limit= Number of _channel_ messages to be fetched after the starting message (all thread messages are fetched) (default: 20)
-v, --verbose Show verbose debug information
--version Output version information
-d, --details Wrap the markdown output in HTML <details> tags
-i, --issue= The URL of a repository to post the output as a new issue, or the URL of an issue to add a comment to that issue
Application Options:
-l, --limit= Number of _channel_ messages to be fetched after the starting message (all thread messages are fetched) (default: 20)
-v, --verbose Show verbose debug information
--version Output version information
-d, --details Wrap the markdown output in HTML <details> tags
-i, --issue= The URL of a repository to post the output as a new issue, or the URL of an issue to add a comment to that issue

Help Options:
-h, --help Show this help message
Arguments:
Start: Required. Permalink for the first message to fetch. Following messages are then fetched from that channel (or thread if applicable)
```
Help Options:
-h, --help Show this help message

Arguments:
Start: Required. Permalink for the first message to fetch. Following messages are then fetched from that channel (or thread if applicable)

## Limitations

Many and varied, but at least:

* No paging is used when fetching messages, so if the conversation is too long the output will be truncated.


## Development

To release a new version, simply tag it. The `goreleaser` workflow will take care of the rest. E.g:
Expand Down

0 comments on commit 476dca0

Please sign in to comment.