feature: automate the creation of proposals/README.md #86
Conversation
|
Looks like I don't have permissions to assign reviewers but maybe @SethTisue @sjrd thoughts on this? |
ckipp01
force-pushed
the
automate
branch
2 times, most recently
from
356d7c3
to
51719e7
Compare
|
LGTM. (Besides, if we ever decide it was a failed experiment, we can just toss the script and go back to hand-maintenance.) |
|
coolness points for using scala-cli 😎 |
While going over the current status of all the proposals and creating scalacenter#85 I figured we could maintain the proposals/README.md a bit different. I can imagine it's easy to forget to update that so I think instead it might be a good idea to instead just use headers in the proposal files themselves. This way all updates to a proposal and to the current status is just done in the actual proposal, and then the README can get generated.
|
I don't have any objection. @ckipp01 FYI I am currently on sickness leave, so please forgive my unresponsiveness. If something's blocked on me, feel free to ping |
|
Thank you Chris for submitting the PR. I must say that I am on the fence, though. I am sympathetic to moving the status information of the proposals to the files instead of in the README, however I am a bit worried that we may misspell something in the YAML front matter and that would break the Scala script that generates the README. I am not sure this is a huge win, to be honest, but I am happy to merge it if the others think it should be! |
If this is the primary worry, let me add a check in the script so that if it comes across an unknown key it fails and fails loudly with a message of exactly what's wrong. I don't have super strong feelings on this, and sort of just did it on a whim 😆. However I do think it's a nice way to manage it. Let me add the check in and then I'll ping you for another review. |
|
Alright, so I updated it. Now if you do make a mistake and use a key that we don't account for or you accidentally misspell something you'll see: This should ensure that when you try to generate it and make a mistake it's right in your face. Wdyt @julienrf ? |
|
Nice, feel free to merge the PR! |
:) I don't have permissions to EDIT: \o/ Now I have the power to! Thanks! |
While going over the current status of all the proposals and creating
#85 I figured we
could maintain the proposals/README.md a bit different. I can imagine
it's easy to forget to update that so I think instead it might be a good
idea to instead just use headers in the proposal files themselves. This
way all updates to a proposal and to the current status is just done in
the actual proposal, and then the README can get generated.