-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Experiment: Interactive mode: generate + commit + lint + commit #214
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for experimenting this out so quickly! I'll try it out.
I have mixed feelings about calling
lint
fromgenerate
.
I understand you'd rather keep these separate, but I don't think it's a good idea to automatically commit the report without linting it.
I'm curious to know if this kind of workflow is easier with regard to accessibility, or if its counter-productive.
I'm not directly affected by lack of accessibility, but I'd be fine with this new behavior being opt-in.
v admin_dir / "weekly" / Fmt.str "%4d" year / Fmt.str "%02i" week / user | ||
|> add_ext "md") | ||
in | ||
let* () = Bos.OS.File.delete file in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okra could abort or warn if the file already exists, or even append new text, instead of silently deleting the file.
Co-authored-by: Antonin Décimo <antonin.decimo@gmail.com>
Alternative workflow I would like to explore: (suggested by @cuihtlauac) |
In my view, the GitHub action generates my weekly PR; I'm to review and amend it with whatever is missing or wrong. |
What is the advantage of linting in the CI, especially if there's some back-and-forth to do to edit/fix the weekly, if the dish can be prepared for serving before its send? |
This would be an alternative for people who don't want to use the cli (so that people still benefit from the auto-generated okra-gen weeklies without the cli) |
To me, the big advantage is I don't need to organize myself. Whatever I do or forget to do, the PR lands in my mailbox. And if I'm late, several stacks up. That's lazy-friendly :-) |
Many thanksfor raisignthe accessibility topic!
I do appreciate people proactively thinking about this aspect and think
it makes a significant difference in terms of feelingincluded. THANKS!
In this case, I regret I won't be able to deep dive into the topic right
now and can share only an intuition: I think the workflow is neutral
/orthogonal to accessibility considerations. Maybe best followed-up at
the off-site if time permits!
|
@cuihtlauac I have added a github action to experiment with that: https://github.com/tarides/admin/pull/57, it might require some minor tinkering (currently some issues with basic unix commands), but we are close to have this workflow working. |
Fix #213
It's an interactive mode integrated to
okra generate
instead of a separate command, but I have mixed feelings about callinglint
fromgenerate
.Also cc @shindere, I'm curious to know if this kind of workflow is easier with regard to accessibility, or if its counter-productive.