|
| 1 | +<h1 align="center"> |
| 2 | + <img src="/doc/user/images/otp-logo.svg" width="120" /><br> |
| 3 | + OpenTripPlanner (OTP) - Digitransit Fork |
| 4 | +</h1> |
| 5 | +<p align="center"> |
| 6 | + <b> |
| 7 | + HSL OTP Deployments ・ |
| 8 | + <a href="https://dev.reittiopas.fi/etusivu">DEV</a> ・ |
| 9 | + <a href="https://reittiopas.hsl.fi/etusivu">PROD</a> |
| 10 | + </b> |
| 11 | +</p> |
| 12 | +<p align="center"> |
| 13 | + <b> |
| 14 | + HSL OTP Debug ・ |
| 15 | + <a href="https://dev-hsl-debug.digitransit.fi/">DEV</a> ・ |
| 16 | + <a href="https://hsl-debug.digitransit.fi/">PROD</a> |
| 17 | + </b> |
| 18 | +</p> |
| 19 | +<p align="center"> |
| 20 | + <b> |
| 21 | + OTP GraphQL Explorer ・ |
| 22 | + <a href="https://dev-api.digitransit.fi/graphiql/hsl">DEV</a> ・ |
| 23 | + <a href="https://api.digitransit.fi/graphiql/hsl">PROD</a> |
| 24 | + </b> |
| 25 | +</p> |
| 26 | + |
| 27 | +# Overview of CI and Branch Configuration |
| 28 | + |
| 29 | +This is the Digitransit fork of [OpenTripPlanner](https://github.com/opentripplanner/OpenTripPlanner). |
| 30 | +The [`digitransit_ext_config`](https://github.com/HSLdevcom/OpenTripPlanner/tree/digitransit_ext_config) branch contains the Digitransit CI configuration and scripts. |
| 31 | + |
| 32 | +> **The contents of the `v2` branch are reset often and nothing is configured to be retained in the branch permanently! |
| 33 | +It should not be used as a base for changes. |
| 34 | +Always use the upstream [`dev-2.x`](https://github.com/opentripplanner/OpenTripPlanner) branch as a base and make contributions there.** |
| 35 | + |
| 36 | +## Relevant Branches |
| 37 | + |
| 38 | +This repository contains the current dev version in-use in the `v2` branch. |
| 39 | +The current prod version comes from the [latest release](https://github.com/HSLdevcom/OpenTripPlanner/releases/latest). |
| 40 | +There is also a `custom-release` branch that is used for building versions of OTP that differ from the `v2` branch. |
| 41 | + |
| 42 | +## CI Configuration |
| 43 | + |
| 44 | +Checkout [`.github/workflows`](/.github/workflows/). The configured CI pipelines build docker images for dev and prod. The built images can be found here: https://hub.docker.com/r/hsldevcom/opentripplanner. |
| 45 | + |
| 46 | +## [`merge_upstream.sh`](https://github.com/HSLdevcom/OpenTripPlanner/blob/digitransit_ext_config/merge_upstream.sh) |
| 47 | + |
| 48 | +This script can be used to merge and push changes from e.g. `upstream/dev-2.x` to the `v2` or `custom-release` branches. |
| 49 | +You need to have `python3` and `jq` installed. |
| 50 | + |
| 51 | +## [`digitransit/RELEASE_CHANGELOG.md`](/digitransit/RELEASE_CHANGELOG.md) |
| 52 | + |
| 53 | +The generated changelog diff can be found in this file, if it exists. |
0 commit comments