docs(deploy): make authorizer logic more clear

umccr / htsget-rs

A server implementation of the htsget protocol for bioinformatics in Rust

https://samtools.github.io/hts-specs/htsget.html

MIT License

40 stars 9 forks source link

docs(deploy): make authorizer logic more clear #224

Closed mmalenic closed 9 months ago

mmalenic commented 9 months ago

Changes

Update wording and naming slightly to make it clear that a JWT authorizer is being used.

mmalenic commented 9 months ago

I feel like automatically changing the code without input doesn't sound like a great idea? Although, I guess clippy and fmt wouldn't do anything destructive?

I tried to address this by adding clippy and fmt to the pre-commit config, although I think this is a new lint, and my Rust installation wasn't up to date.

mmalenic commented 9 months ago

Sure. We can make another PR for it if we want. I'm not totally against it, we have other automation which makes commits and changes code, e.g. the deployment changelog or dependabot.

It could potentially be annoying if it changes the code on the working branch, and then you make another commit but the push gets rejected because of an out of date local branch. Although, I suspect this wouldn't happen that often because it only runs on a pull request.