Skip to content

Add `routes.txt` with `rails routes` dump

Anatoli Babenia requested to merge abitrolly/gitlab:route-info into master

What does this MR do and why?

Rails routes is an important concept to find an entrypoint to understand how code works. Even before writing code it is useful to take a look at the routes table to unwind the logic starting from the URL of the page that needs to be fixed.

Unfortunately, viewing routes requires a working GDK setup.

https://docs.gitlab.com/ee/development/routing.html#view-all-available-routes

It is not always possible to setup GDK, and it is takes time to start even in prebaked environments like Gitpod. So a cached version of actual routes could really save a day for people who are just looking how things work, and maybe even inspire them to take a next step towards MR.

Ideally this file should be regenerated automatically and contain a header explaining how it is done.

A wishlist:

For now routes.txt is just a manual dump of rails routes.

Screenshots or screen recordings

image

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports