Skip to content

Commit 7bf5c91

Browse files
committed
Update documentation and version bump.
1 parent 47d9523 commit 7bf5c91

File tree

3 files changed

+25
-10
lines changed

3 files changed

+25
-10
lines changed

CHANGELOG.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
66
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
77

8+
## [2.1.0-rc2] 2019-05-29
9+
### Added
10+
- Split unit tests in separate test files.
11+
- Added linting to CircleCI
12+
- Added try/except blocks around plugin configuration code to improve installation and startup
13+
experience when there are errors in the configuration.
14+
15+
### Changed
16+
- Fixed dictionary keys to reference 'apikey' consistently.
17+
- Switch CircleCI from calling pytest directly to using Makefile.
18+
- Dropped using sseclient-py in favour of btubbs sseclient.
19+
- Corrected references to apikey configuration.
20+
21+
### Removed
22+
823
## [2.1.0-rc1] 2019-05-15
924
### Added
1025
- unit tests for more low level objects used by err-stackstorm.
@@ -13,7 +28,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1328
- updated makefile to be better adapted to CircleCI's build process. (Still a work in progress)
1429
- numerious documentation updates to improve installation process for new users.
1530
- documented errbot's ACL features.
16-
31+
1732
### Removed
1833
- removed unused code for keyring and vault.
1934

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ STACKSTORM = {
9595
'password': "my_password",
9696
},
9797
'token': "<User token>",
98-
'key': '<API Key>'
98+
'apikey': '<API Key>'
9999
},
100100
'rbac_auth': {
101101
'standalone': {},
@@ -113,7 +113,7 @@ Option | Description
113113
`api_auth.user.name` | Errbot username to authenticate with StackStorm.
114114
`api_auth.user.password` | Errbot password to authenticate with StackStorm.
115115
`api_auth.token` | Errbot user token to authenticate with StackStorm. Used instead of a username/password pair.
116-
`api_auth.key` | Errbot API key to authenticate with StackStorm. Used instead of a username/password pair or user token.
116+
`api_auth.apikey` | Errbot API key to authenticate with StackStorm. Used instead of a username/password pair or user token.
117117
`timer_update` | Unit: seconds. Default is *60*. Interval for err-stackstorm to the user token is valid.
118118
`rbac_auth.standalone` | Standalone authentication.
119119
`rbac_auth.clientside` | Clientside authentication, a chat user will supply StackStorm credentials to err-stackstorm via an authentication page.
@@ -202,10 +202,10 @@ original authentication method.
202202
err-stackstorm provides a way to associate the chat service user account with a StackStorm
203203
username/password or api token.
204204
205-
This implementation is specific to err-stackstorm. It is achieved by requesting a new
206-
authentication session with err-stackstorm. A Universally Unique Identifier (UUID) is generated
207-
for the session and the chat user is invited to follow a URL to the authentication page hosted by
208-
errbot. For security reasons, the UUID is a one time use and is consumed when the page is
205+
This implementation is specific to err-stackstorm. It is achieved by requesting a new
206+
authentication session with err-stackstorm. A Universally Unique Identifier (UUID) is generated
207+
for the session and the chat user is invited to follow a URL to the authentication page hosted by
208+
errbot. For security reasons, the UUID is a one time use and is consumed when the page is
209209
accessed. Any subsequent attempts to access the page will result in an error.
210210
211211
The login page must be protected by TLS encryption and ideally require an ssl client certificate.
@@ -272,8 +272,8 @@ ACCESS_CONTROLS = {
272272
```
273273
274274
275-
Getting the correct usernames to fill into `allowusers`/`denyusers` isn't obvious. On a small
276-
scale it's possibel to use the `!whoami` command to get the correct user account name. For large
275+
Getting the correct usernames to fill into `allowusers`/`denyusers` isn't obvious. On a small
276+
scale it's possibel to use the `!whoami` command to get the correct user account name. For large
277277
installation it'd make more sense to use a pre-defined pattern.
278278
279279
Errbot matches `username` against the ACL definition. This information isn't found easily in the Slack interface. Use errbot's `!whoami` command to find the value from the `nick` field which can be used with ACL definitions.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="err-stackstorm",
8-
version="2.0.0",
8+
version="2.1.0-rc2",
99
author="Err-StackStorm Plugin contributors",
1010
author_email="[email protected]",
1111
description="An Errbot plugin for StackStorm ChatOps.",

0 commit comments

Comments
 (0)