Shopify / shipit-engine

Deployment coordination
https://shopify.engineering/introducing-shipit
MIT License
1.42k stars 144 forks source link

Adjust GitHub team slug size #1233

Closed ajshepley closed 2 years ago

ajshepley commented 2 years ago

GitHub's docs do not seem to specify a limit to the maximum length of a team name or slug size. I've observed a couple of instances of a team slug being too big for this field, so this PR updates it to the max string size (255), which matches the Team Name max length as well.

Another option would be to trim the slug, but it's used in record lookups and creation, so that could be problematic. Likewise, it could potentially be used in API requests at some point (though I don't think we do so here), and so it makes more sense to keep the field "accurate" to the information we receive.

A last option would be to change the field to the TEXT type, but I think we would also want to change the team name to be a longer length as well, and I'm not sure if we've seen a slug longer than (or approaching) 255 before. So I think this is a simple approach we can take for now, and we can alter both fields together at a later date if it becomes necessary.