Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit 31b37d9

Browse files
committed
Add jira and slack integrations to staging
1 parent 9cfb135 commit 31b37d9

3 files changed

Lines changed: 74 additions & 4 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
11
# Jira (Atlassian Cloud)
2+
3+
The CodeStream Jira Cloud integration requires users to go through the OAuth
4+
process. This requires a developer app in an Atlassian account to enable the
5+
OAuth handshake and grant access to the system.
6+
7+
## Creating Developer App for OAuth
8+
9+
1. Login to your Atlassian cloud account and go to [the developer apps
10+
site](https://developer.atlassian.com/apps/).
11+
12+
1. Create > OAuth 2.0 Integrations
13+
14+
1. Distribution > Enable sharing; Also, complete the rest of the page
15+
16+
1. Permissions > Add Jira Platform REST API
17+
18+
1. Confiure Jira Platform Rest API
19+
- Add **View Jira Issue Data**
20+
- Add **Create and Manage Issues**
21+
- Verify **View user profiles** has been added
22+
23+
1. Authorization > User persistent refresh token
24+
25+
1. Set callback URL like `https://stg-api.codestream.us/no-auth/provider-token/jira`
26+
27+
1. Add the client ID, secret, etc.. to the CodeStream server config.
28+
```
29+
{
30+
"integrations": {
31+
"jira": {
32+
"cloud": {
33+
"appClientId": "*************************",
34+
"appClientSecret": "**********************************",
35+
"disabled": false
36+
}
37+
}
38+
}
39+
```

api_server/docs/integrations/slack.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Steps to create a Slack App for a non-production CodeStream environment.
2828
them.
2929
* Add the following Redirect URL:
3030
- `https://<codestream-api-host>/no-auth/provider-token/slack`
31-
* Add the following Scopes and save them (Request reasons included here):
31+
* Add the following Scopes and save them (Request reasons included
32+
here). _NOTE: the source of truth for the list of scopes is [here]().
33+
You should verify this list accordingly._
3234
- **channels:read** - We allow users to select a public channel to share
3335
to.
3436
- **chat:write** - Users can send a copy of their messages from
@@ -56,7 +58,7 @@ workspaces that wish to connect with the corresponding CodeStream environment.
5658
## Update the CodeStream Configuration
5759

5860
Finally, add the secrets and configuration data to the CodeStream API server's
59-
configuration file. The following data is needed:
61+
configuration file in the **integrations** section.
6062

6163
From the **Basic Information** page of the Slack App, get these data and add
6264
them to the CodeStream configuration file.
@@ -67,6 +69,31 @@ them to the CodeStream configuration file.
6769
- Signing Secret
6870

6971

72+
```
73+
{
74+
"integrations": {
75+
"slack": {
76+
"cloud": {
77+
"appClientId": null,
78+
"appClientSecret": null,
79+
"appId": null,
80+
"appSharingClientId": "*******************************",
81+
"appSharingClientSecret": "********************************",
82+
"appSharingId": "***************************",
83+
"appSharingSigningSecret": "**************************",
84+
"appSigningSecret": null,
85+
"appStrictClientId": null,
86+
"appStrictClientSecret": null,
87+
"appStrictId": null,
88+
"appStrictSigningSecret": null,
89+
"disabled": false,
90+
"interactiveComponentsEnabled": true
91+
}
92+
}
93+
}
94+
}
95+
```
96+
7097
## Permalink to Code Requesting Auth
7198

7299
This is the _source of truth_ where slack access is concerned.

shared/codestream_configs/profiles/cloud.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,9 @@
216216
"prod": {
217217
"_loadSecretsFile": "atlassian/prod.cfg"
218218
},
219-
"stg": {}
219+
"stg": {
220+
"_loadSecretsFile": "atlassian/stg.cfg"
221+
}
220222
}
221223
},
222224
"linear": {
@@ -289,7 +291,10 @@
289291
"_loadSecretsFile": "slack/qa-combined.cfg",
290292
"interactiveComponentsEnabled": true
291293
},
292-
"stg": {}
294+
"stg": {
295+
"_loadSecretsFile": "slack/stg-combined.cfg",
296+
"interactiveComponentsEnabled": true
297+
}
293298
}
294299
},
295300
"trello": {

0 commit comments

Comments
 (0)