https://github.com/is2ei/auto-plugin-typetalk

"auto" plugin to post your release notes to Typetalk
https://github.com/is2ei/auto-plugin-typetalk

Last synced: about 2 months ago
JSON representation

"auto" plugin to post your release notes to Typetalk

• Host: GitHub
• URL: https://github.com/is2ei/auto-plugin-typetalk
• Owner: is2ei
• License: mit
• Created: 2019-10-27T11:29:32.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T23:32:17.000Z (over 3 years ago)
• Last Synced: 2026-02-14T05:40:11.701Z (4 months ago)
• Language: TypeScript
• Size: 509 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
auto-typetalk-plugin

===

[![Build Status](https://travis-ci.com/is2ei/auto-plugin-typetalk.svg?branch=master)](https://travis-ci.com/is2ei/auto-plugin-typetalk)

[![codecov](https://codecov.io/gh/is2ei/auto-plugin-typetalk/branch/master/graph/badge.svg)](https://codecov.io/gh/is2ei/auto-plugin-typetalk)

[auto](https://intuit.github.io/auto/pages/introduction.html) plugin to post your release notes to Typetalk.

## Installation

This plugin is not included with the `auto` CLI installed via NPM. To install:

```sh

npm i --save-dev auto-typetalk-plugin

# or

yarn add -D auto-typetalk-plugin

```

## Prerequisites

To post messages to Typetalk you need the following secrets set in your environment:

- `TYPETALK_TOKEN`

- `TYPETALK_TOPIC_ID`

## Usage

To use this plugin include it in your `.autorc`

```json

{

  "plugins": [

    ["typetalk"]

  ]

}

```

With mentions

```json

{

  "plugins": [

    ["typetalk", { "mentions": [ "all", "here", "bob" ]}]

  ]

}

```

For working example, see:

https://github.com/is2ei/auto-plugin-typetalk-example