This repository is no longer recommended or maintained and it will soon be marked as archived in Github. Huge thanks to the original authors and contributors for providing this Github Actions template to our community. To add Stack Overflow interactions to your Orbit workspace, you can now request access to the Stack Overflow integration under Workspace Settings > Integrations.

This is a JavaScript package that can be used to integrate Stack Overflow questions with a specified tag into your organization's Orbit workspace.

To set up this integration you will need some details from StackOverflow. During the setup, we will need to create a new application on Stack Apps which will allow this integration to interact with the platform. The application will contain a Key which we should take note of for later.

1. Head to Stack Apps and login in to your account.
2. Register a new Stack Apps application. The oauth domain can be anything, as can the application website.
3. In your application settings, take note of your Key value.

The application requires the following environment variables:

Install the package with the following command

$ npm install @orbit-love/stackoverflow

The standard initialization of the library requires the following signature:

const OrbitStackOverflow = require('@orbit-love/stackoverflow')
const orbitStackOverflow = new OrbitStackOverflow('orbitWorkspaceId', 'orbitApiKey', 'stackAppsKey')

If you have the following environment variables set: ORBIT_WORKSPACE_ID, ORBIT_API_KEY, and STACK_APPS_KEY then you can initialize the client as follows:

const OrbitStackOverflow = require('@orbit-love/stackoverflow')
const orbitStackOverflow = new OrbitStackOverflow()

// Allows you to go back a number of hours and only get questions in that timeframe
const questions = await orbitStackOverflow.getQuestions({ tag: 'tag-1', hours: 24 })
const prepared = await orbitStackOverflow.prepareQuestions(questions)
const summary = await orbitStackOverflow.addActivities(prepared)
console.log(summary)

There are several options when calling the prepareQuestions() method. The default is 'orbitActivity'.

// Returns question list as Orbit activity objects
await orbitStackOverflow.prepareQuestions(questions, 'orbitActivity')

// Returns questions that have at least one answer
await orbitStackOverflow.prepareQuestions(questions, 'hasAnswer')

// Returns questions with recent activity
await orbitStackOverflow.prepareQuestions(questions, 'recentActivity', { hours: 24 })

// Returns questions that are new within a number of hours - useful for post-fetching filtering
await orbitStackOverflow.prepareQuestions(questions, 'postedWithinHours', { hours: 24 })

// Returns an array of question IDs only
await orbitStackOverflow.prepareQuestions(questions, 'onlyIds')

const questionIds = [123, 456, 789]
const answers = await orbitStackOverflow.getAnswers({ ids: questionIds, hours: 24 })
const prepared = await orbitStackOverflow.prepareAnswers(questions)
const summary = await orbitStackOverflow.addActivities(prepared)
console.log(summary)

To use this package you do not need to install it, but will need Node.js installed on your machine.

To use the CLI you must have the following environment variables set: ORBIT_WORKSPACE_ID, ORBIT_API_KEY, and STACK_APPS_KEY.

npx @orbit-love/stackoverflow [FLAGS]

npx @orbit-love/stackoverflow --questions --tag=tag-1 [--hours=12]

• --hours is optional and defaults to 24.

npx @orbit-love/stackoverflow --answers --tag=tag-1 [--hours=12]

• --hours is optional and defaults to 24.
• This will only get answers on questions posted in the last 28 days.

npx @orbit-love/stackoverflow --questions --answers --tag=tag-1 [--hours=12]

• --hours is optional and defaults to 24.
• This will only get answers on questions posted in the last 28 days.

⚡ You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.

See our guide for setting up this automation.

We 💜 contributions from everyone! Check out the Contributing Guidelines for more information.

This project is under the MIT License.

This project uses the Contributor Code of Conduct. We ask everyone to please adhere by its guidelines.