https://github.com/zxdong262/github-upgrade-server

Server provide upgrade info for github release
https://github.com/zxdong262/github-upgrade-server

server upgrade

Last synced: about 1 month ago
JSON representation

Server provide upgrade info for github release

• Host: GitHub
• URL: https://github.com/zxdong262/github-upgrade-server
• Owner: zxdong262
• License: mit
• Created: 2019-07-29T02:34:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T00:50:34.000Z (almost 2 years ago)
• Last Synced: 2024-11-02T00:32:50.858Z (3 months ago)
• Topics: server, upgrade
• Language: JavaScript
• Size: 2.41 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# github upgrade server

[![Build Status](https://travis-ci.org/zxdong262/github-upgrade-server.svg?branch=release)](https://travis-ci.org/zxdong262/github-upgrade-server)

Github upgrade server will receive github new release webhook request, and update version, log and assets list in database, and provide version upgrade info query.

It is designed to work with AWS lambda, Dynamodb or SQL db.

## Run in local

```bash

# get the code

git clone [email protected]:zxdong262/github-upgrade-server.git

# install dependencies

cd github-upgrade-server

npm i

# create configs

cp env-sample.env .env

# then edit .env, fill all required at least

## run local server

npm start

## test

npm run test

## start local dynamodb server

npm run dynamo

```

## Use

```js

let data = GITGUB_RELEASE_WEBHOOK_PAYLOAD

// update version info

let url1 = `${serverUrl}/update-upgrade-info-${UPGRADE_SERVER_API_PREFIX}`

let res1 = await axios.post(url1, data, {

  headers: {

    'X-Hub-Signature': enc(data)

  }

}).then(r => r.data)

console.log('res1', res1)

expect(res1.toString()).toEqual('ok')

// get version info

let url3 = `${serverUrl}/upgrade-info?name=${data.repository.name}`

let res2 = await axios.get(url3).then(r => r.data)

console.log('res2', res2)

expect(res2.id).toEqual(data.repository.name)

expect(res2.version).toEqual(data.release.tag_name)

```

- So you can set webhook in github repo setting, set secret same as `UPGRADE_SECRET` in `.env`, when new release published, the server will update version info.

- Then you can get version info from server to check if should upgrade.

## Deploy to AWS Lambda

```bash

# create configs

cp deploy/env.sample.yml deploy/env.yml

cp deploy/serverless.sample.yml deploy/serverless.yml

# then edit deploy/env.yml and deploy/serverless.yml

# build and deploy to AWS Lambda with serverless, make sure you run it in linux

npm run build

npm run deploy

```

## License

MIT