OpenTripPlanner/script
2025-02-14 17:30:58 +01:00
..
images Release script for downstream OTP forks. 2025-02-12 15:20:43 +01:00
changelog-diff.py Release script for downstream OTP forks. 2025-02-12 15:20:43 +01:00
custom-release.py Apply changes from review 2025-02-14 17:30:58 +01:00
CUSTOM_RELEASE_README.md Apply changes from review 2025-02-14 17:30:58 +01:00
otp doc: Fix references to the otp-shaded jar in doc. 2024-12-10 20:31:15 +01:00
otp-ui refactor: Move scripts to the root script folder 2024-10-11 16:27:45 +02:00
Readme.md Apply suggestions from code review 2024-03-12 14:00:32 +01:00
run-and-test-otp doc: Fix references to the otp-shaded jar in doc. 2024-12-10 20:31:15 +01:00
test.py Apply changes from review 2025-02-14 17:30:58 +01:00

Scripts

This folder is intended for various scripts used during the OTP development. They are provided "as is" and the "owner" may do whatever she/he likes with it.

If you want to submit your own scripts, you need to include:

  • A header at the beginning of the script stating who the owner is.
  • The script should print some usage documentation if invoked with --help and -h.

The regular pull-request approval process is required for submitting new scripts and changing existing one. The reviewers are responsible for:

  • Is this script relevant for OTP and at least one active member of the OTP community?
  • Is the script harmful?
  • Does the script have sufficient documentation?
    • Owner section
    • Print help with -h and --help

Example

# Owner: J. Brown, Fun & Fast Transit Inc

if [ "$1" == "-h" ]  || [ "$1" == "--help" ]; then
  echo "The purpose of the script is .."
  echo "Usage: ..."
  echo "Parameters: "
  :
fi