feat(package): publish the app as an npm package #847

travi · 2024-01-12T20:58:39Z

No description provided.

to improve the ability to include into an existing Probot app as a dependency Co-authored-by: Julie Van Kirk <VanKirkJulieA@JohnDeere.com> Co-authored-by: Douglas Johnson <JohnsonDouglas@JohnDeere.com>

Co-authored-by: Julie Van Kirk <VanKirkJulieA@JohnDeere.com> Co-authored-by: Douglas Johnson <JohnsonDouglas@JohnDeere.com>

vercel · 2024-01-12T20:58:45Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
app	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 13, 2024 3:37am

… methods

travi · 2024-01-12T21:03:15Z

docs/configuration.md

i plan to give more attention to improving the details in this doc, but wanted to get it moved to its own file so that the readme was less noisy and folks can find their way to getting started more easily

travi · 2024-01-12T21:04:36Z

docs/self-host.md

+```js
+import {Server, Probot, ProbotOctokit} from 'probot';
+import app from '@repository-settings/app';
+
+async function start() {
+  const log = getLog();
+  const server = new Server({
+    Probot: Probot.defaults({
+      appId: process.env.APP_ID,
+      privateKey: process.env.PRIVATE_KEY,
+      secret: process.env.WEBHOOK_SECRET,
+      Octokit: ProbotOctokit.defaults({
+        baseUrl: process.env.GH_API
+      }),
+      log: log.child({
+        name: 'repository-settings'
+      })
+    }),
+    log: log.child({
+      name: 'server'
+    })
+  });
+
+  process.on('SIGTERM', async () => {
+    console.log('Received SIGTERM, stopping server!');
+
+    await server.stop();
+  });
+
+  await server.load(app);
+
+  await server.start();
+};
+
+start();
+```


interested in whether you think there is a simpler example that would help folks understand the goal, or even a more generic probot doc to link to, but wanted to provide some level of guidance here

I think if you don't need any custom functionality and you want a long-running process, I think there is no code necessary at all, you should be able to do "start": "probot run node_modules/@repository-settings/app/index.js", or maybe @repository-settings/app should expos its own binary like "start": "repository-settings"?

If users need more customization, for example for a serverless environment, then we can point them to https://probot.github.io/docs/development/#run-probot-programmatically and maybe provide an example for a serverless app?

i like the idea of including a few different variations from simplest to most customizability.

maybe @repository-settings/app should expos its own binary like "start": "repository-settings"?

i like this idea

travi · 2024-01-12T21:05:17Z

docs/self-host.md

+npm install @repository-settings/app
+```
+
+#### Example node.js app


in addition to this sort of example, i could see value in providing a minimal example for deploying to a serverless environment. i dont have as much experience with that approach lately, so open to suggestions. i dont think adding that needs to block getting this progress merged, but could be a valuable follow up

I think it's a good idea, but we can do a follow up for that.

travi · 2024-01-12T21:07:55Z

docs/self-host.md

+## Permissions & events
+
+This plugin requires these **Permissions & events** for the GitHub Integration:
+
+### Permissions
+
+- Administration: **Read & Write**
+- Contents: **Read only**
+- Issues: **Read & Write**
+- Single file: **Read & Write**
+  - Path: `.github/settings.yml`
+- Actions: **Read only**
+
+### Organization Permissions
+
+- Members: **Read & Write**
+
+### Events
+
+- Push
+- Repository


i don't know how accurate these even still are, but wanted to get them moved into this doc as-is for now. can adjust for correctness as a follow up. i also realized that we also havent added the file to enable the manifest flow, which is probably the better source of truth to maintain, so maybe that is the better follow up here

travi · 2024-01-12T21:08:59Z

docs/deploy.md

@@ -1,25 +0,0 @@
-# Deploying
-
-If you would like to run your own instance of this plugin, see the [docs for deploying plugins](https://github.com/probot/probot/blob/master/docs/deployment.md).


i dont think the plugins approach is even valid anymore, so i captured the idea of this more as just forking the repo.

gr2m

I couldn't try out the code but from looking at it this is great, I'd move forward and then iterate on it as needed

gr2m · 2024-01-14T18:47:17Z

README.md

+    * [Hosted GitHub.com App](#hosted-githubcom-app)
+    * [Self-Hosted App](#self-hosted-app)
+  * [Configuration](#configuration)
+* [Security Implications](#security-implications)


I usually leave out a TOC these days, because GitHub has its own build into the UI now, and unless updating a TOC in a markdown file is automated it tends to get out of sync with the actually sections.

thats fair. my reason for including is usually more for drawing attention to sections below the fold. i've known about the built-toc, but it is so hidden that i actually forgot it is even there, so i dont know that it accomplishes that goal.

updating this one is fairly automatic because of the generate:md script that uses remark to update. i dont have a way to fully automate in mind, but i've wanted to investigate a way to fail verification if running the generate script would result in a diff.

open to more feedback on this, but lets address after getting his iteration merged

gr2m · 2024-01-14T18:48:05Z

docs/self-host.md

+npm install @repository-settings/app
+```
+
+#### Example node.js app


I think it's a good idea, but we can do a follow up for that.

gr2m · 2024-01-14T18:52:06Z

docs/self-host.md

+```js
+import {Server, Probot, ProbotOctokit} from 'probot';
+import app from '@repository-settings/app';
+
+async function start() {
+  const log = getLog();
+  const server = new Server({
+    Probot: Probot.defaults({
+      appId: process.env.APP_ID,
+      privateKey: process.env.PRIVATE_KEY,
+      secret: process.env.WEBHOOK_SECRET,
+      Octokit: ProbotOctokit.defaults({
+        baseUrl: process.env.GH_API
+      }),
+      log: log.child({
+        name: 'repository-settings'
+      })
+    }),
+    log: log.child({
+      name: 'server'
+    })
+  });
+
+  process.on('SIGTERM', async () => {
+    console.log('Received SIGTERM, stopping server!');
+
+    await server.stop();
+  });
+
+  await server.load(app);
+
+  await server.start();
+};
+
+start();
+```


I think if you don't need any custom functionality and you want a long-running process, I think there is no code necessary at all, you should be able to do "start": "probot run node_modules/@repository-settings/app/index.js", or maybe @repository-settings/app should expos its own binary like "start": "repository-settings"?

If users need more customization, for example for a serverless environment, then we can point them to https://probot.github.io/docs/development/#run-probot-programmatically and maybe provide an example for a serverless app?

travi · 2024-01-16T05:11:57Z

merging this iteration, with the intention to follow up on the remaining comments in later iterations

github-actions · 2024-01-16T05:13:41Z

🎉 This PR is included in version 2.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

travi and others added 4 commits January 4, 2024 10:54

feat(package): publish the app as an npm package

8442226

to improve the ability to include into an existing Probot app as a dependency Co-authored-by: Julie Van Kirk <VanKirkJulieA@JohnDeere.com> Co-authored-by: Douglas Johnson <JohnsonDouglas@JohnDeere.com>

ci(release): enabled running on beta branches

d877571

Co-authored-by: Julie Van Kirk <VanKirkJulieA@JohnDeere.com> Co-authored-by: Douglas Johnson <JohnsonDouglas@JohnDeere.com>

fix: limit files included in the package to only source files

6f351a9

Co-authored-by: Julie Van Kirk <VanKirkJulieA@JohnDeere.com> Co-authored-by: Douglas Johnson <JohnsonDouglas@JohnDeere.com>

ci(permissions): defined appropriate permissions for publishing

ddb8877

Co-authored-by: Julie Van Kirk <VanKirkJulieA@JohnDeere.com> Co-authored-by: Douglas Johnson <JohnsonDouglas@JohnDeere.com>

travi requested a review from gr2m January 12, 2024 20:58

docs(self-host): reorganized docs to account for various self-hosting…

0298b0a

… methods

travi force-pushed the beta branch from 61bff20 to 0298b0a Compare January 12, 2024 21:01

vercel bot deployed to Preview – app January 12, 2024 21:02 View deployment

travi commented Jan 12, 2024

View reviewed changes

vercel bot deployed to Preview – app January 12, 2024 23:31 View deployment

docs(toc): generated table of contents using remark

ca66154

travi force-pushed the beta branch from 7fb4972 to ca66154 Compare January 13, 2024 03:37

vercel bot deployed to Preview – app January 13, 2024 03:37 View deployment

gr2m approved these changes Jan 14, 2024

View reviewed changes

travi merged commit 8bc2125 into master Jan 16, 2024
8 checks passed

travi deleted the beta branch January 16, 2024 05:12

github-actions bot added the released label Jan 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(package): publish the app as an npm package #847

feat(package): publish the app as an npm package #847

travi commented Jan 12, 2024

vercel bot commented Jan 12, 2024 •

edited

travi Jan 12, 2024

travi Jan 12, 2024

gr2m Jan 14, 2024

travi Jan 16, 2024

travi Jan 12, 2024

gr2m Jan 14, 2024

travi Jan 12, 2024

travi Jan 12, 2024

gr2m left a comment

gr2m Jan 14, 2024

travi Jan 16, 2024

gr2m Jan 14, 2024

gr2m Jan 14, 2024

travi commented Jan 16, 2024

github-actions bot commented Jan 16, 2024

		@@ -1,25 +0,0 @@
		# Deploying

		If you would like to run your own instance of this plugin, see the [docs for deploying plugins](https://github.com/probot/probot/blob/master/docs/deployment.md).

feat(package): publish the app as an npm package #847

feat(package): publish the app as an npm package #847

Conversation

travi commented Jan 12, 2024

vercel bot commented Jan 12, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gr2m left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

travi commented Jan 16, 2024

github-actions bot commented Jan 16, 2024

vercel bot commented Jan 12, 2024 •

edited