Skip to content

Commit 9bb3859

Browse files
committed
Added self-hosted release notes
1 parent 44da1f1 commit 9bb3859

File tree

4 files changed

+30
-1
lines changed

4 files changed

+30
-1
lines changed

docs/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@
55
- [Security](./security.md)
66
- [Settings](./settings.md)
77
- [Self Hosted](./self_hosted.md)
8+
- [Deployment Guide](./self_hosted.md)
9+
- [Release Notes](./self_hosted_release_notes.md)
810
- [Enterprise Security](./enterprise_security.md)

docs/images/gh-app-5.png

-810 KB
Loading

docs/self_hosted.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Self Hosted
1+
# Self Hosted Deployment Guide
22

33
_This tutorial shows how to deploy GitNotebooks Self-Hosted_
44

@@ -78,6 +78,9 @@ You should now have a GitHub App with the following settings:
7878
- Email address: `Read only`
7979
- Subscribe to events:
8080
- Pull request
81+
- Pull request review
82+
- Pull request review comment
83+
- Pull request review thread
8184

8285
### After creating the GitHub App
8386

docs/self_hosted_release_notes.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Self Hosted Release Notes
2+
3+
---
4+
5+
## gitnotebooks/self-hosted:1.2.1
6+
7+
- **Features**
8+
- Bi-directional comment syncing between GitHub and GitNotebooks. If a comment is posted in GitNotebooks, it will be cross-posted to the corresponding JSON line in GitHub. If a comment is posted in GitHub, it will be shown in the corresponding rendered notebook line. Syncs comment edit and delete as well
9+
- Ability to "Add suggestion" to a notebook or code file and then apply the change within GitHub
10+
- Added a repo file explorer similar to a repo's home page in GitHub to allow notebook reviewers to quickly check python modules referenced from a notebook
11+
- Log more events and improved readability of server logs: `INFO`, `WARN`, `ERROR`, instead of `30`, `40`, `50`
12+
- View self hosted license information from the app home page: number of seats, expiration, license type
13+
- **Bug Fixes**
14+
15+
- File renames are now handled better. Comments used to disappear if they were posted to a renamed file and then a subsequent change was pushed to that notebook. This, and other edge cases related to rename behavior, has been fixed
16+
17+
> **Required Changes:** In order to upgrade to version 1.2.1 there are three requirements
18+
>
19+
> 1. Set a new environment variables `LICENSE_KEY`
20+
> 2. Allow egress from the GitNotebooks service to https://license.gitnotebooks.com
21+
> 3. Modify the GitNotebooks GitHub App to subcribe to the following events
22+
> - Pull request review
23+
> - Pull request review comment
24+
> - Pull request review threadPull request thread comment

0 commit comments

Comments
 (0)