Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supermedium/a-frobot
🤖 A-Frame GitHub bot.
https://github.com/supermedium/a-frobot
bot
Last synced: 6 days ago
JSON representation
🤖 A-Frame GitHub bot.
- Host: GitHub
- URL: https://github.com/supermedium/a-frobot
- Owner: supermedium
- License: mit
- Created: 2016-12-22T07:41:48.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T07:18:29.000Z (3 months ago)
- Last Synced: 2024-08-30T00:25:30.652Z (3 months ago)
- Topics: bot
- Language: JavaScript
- Homepage: https://github.com/a-frobot
- Size: 201 KB
- Stars: 9
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A-Frobot
A-Frame GitHub bot.
[Latest A-Frame GitHub Pages](https://a-frobot.github.io/aframe/)
Deployed on AWS.
## Actions
- When the A-Frame code or package.json is updated, bump the A-Frame master
builds and the bot's fork's GitHub Pages of A-Frame.
- When the A-Frame master builds are bumped: update README, package.json, and bump again.
- When the A-Frame documentation is updated, deploy the documentation on the A-Frame site.
- When the A-Frame Registry is updated, bump the A-Frame Registry builds and site.
- When a contributor comments `@a-frobot docs-v0.4.0` on a commit, cherry-pick
the commit to the documentation branch and deploy the A-Frame site.
- When the A-Frame site is updated, deploy the A-Frame site to `aframevr/aframevr.github.io`.
## AWS Setup
Open inbound ports in the AWS Security Group on the console. A-Frobot defaults
to port 5000 for production and port 5001 for staging.
```sh
sudo apt-get install git
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
```
open a new console with `bash`, then continue:
```sh
nvm install 22
nvm alias default 22 # needed if you previously installed an older version
git clone [email protected]:supermedium/a-frobot && cd a-frobot && npm install
cp tokens.js.dist tokens.js
```
Have a GitHub account and get a GitHub personal access token. Put the token
in `tokens.js` as `GITHUB_TOKEN`.
Give the GitHub bot account write access to the managed repositories.
Get the AWS public URL and set up a GitHub webhook on the managed repositories
pointing to `/postreceive`. Give the webhook a secret token. Put the webhook
token in `tokens.js` as `SECRET_TOKEN`. Make sure the content type for the
webhook is set to `application/json`.
```sh
npm run start
./node_modules/.bin/forever logs 0
```
For proper functioning, the instance should have at least 2GB of RAM, and the
instance's volume should have at least 2GB of storage.
### Staging
```sh
npm run startstaging
```
## Repository Setup
- aframevr/aframe - Webhook + Write Access
- aframevr/aframe-registry - Webhook + Write Access
- aframevr/aframe-site - Webhook
- aframevr/aframevr.github.io - Write Access
- a-frobot/aframe - Fork