Skip to content

merlinc/release-status-graphql

Repository files navigation

Release Status

Release Status is a dashboard to show you what you have, and would like to release. It does this by combining information from your git, build, and bug tracking systems.

It currently supports Github and CircleCI.

It is an reworking of UKHomeOffice/passport-ticket-status to provide a API agnostic backend API written in GraphQL, and a SSR frontend application using Next.JS

This particular repository is the GraphQL backend.

Example screenshots

Without ticket information

without-tickets

With linked ticket information

tickets

Quality Metrics

Codescene

Get more details at codescene.io.

Coveralls

Coverage Status

Glossary

  • Ticket - A story task representing work to do
  • Commits - Entries made into a git system, which may refer to one or more tickets
  • Build - A discrete package of code consisting of at least one commit.
  • Deploy - A placement of a build into an environment

Running

npm run start or npm run start:watch to reload when changes are made.

Running in Docker

This can be started from the frontend project using docker-compose or standalone.

In both cases a configuration file needs to be attached as a volume, matching this pattern:

// - path_outside_container:path_inside_container
  - ${CONFIG_FILE}:/src/config/default.json

Config

An example config has been provided, the most important part is the project config:

{
  "projects": [
    {
      "org": "facebook",
      "project": "react",
      "type": "library",
      "promotions": ["staging", "production"]
    }
  ]
}

This config defined a github project of facebook/react with two promotion states, staging and production`.

API keys should also be provided as follows:

{
  "api": {
    "circleCI": {
      "token": "CIRCLECI_TOKEN_GUID"
    },
    "github": {
      "token": "GITHUB_TOKEN_GUID"
    }
  }
}

Tests

Run npm test

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published