feat(KNO-4537): Add "knock commit list" command in cli #256
Conversation
| @@ -88,7 +88,8 @@ export default class CommitList extends BaseCommand<typeof CommitList> { | |||
| }, | |||
| commit_message: { | |||
| header: "Commit message", | |||
| get: (entry) => entry.commit_message?.trim(), | |||
| get: (entry) => | |||
| entry.commit_message ? entry.commit_message.trim() : "", | |||
There was a problem hiding this comment.
Sometimes there are new lines after a given entry, which looks really bad in the terminal. After digging into this, I realized the solution is to delete all whitespaces in the commit message, which seems to generate new lines.
Before:
After:
There was a problem hiding this comment.
Yep that makes sense.
One related question though — what happens with a really long commit message? In the screenshots above, it looks like we are doing truncation and I'm guessing that's automatically done by oclif?
There was a problem hiding this comment.
Yes initially I added a custom truncation function, but I removed it because oclif already uses one. And it works very well, the table takes all screen space available and the message truncates if it does not fit in the column.
There was a problem hiding this comment.
And it works very well, the table takes all screen space available and the message truncates if it does not fit in the column.
Got it, thanks for clarifying. One issue here though is then, what happens if you want to see the entire identifier or the commit message without getting truncated? Just thinking out loud, we may need the commit get command for this?
There was a problem hiding this comment.
Good catch, we can do that in another PR if we feel like it.
And from what I've tested, the ID never gets truncated (because the length of the ID never changes and can't be that long i think)
There was a problem hiding this comment.
Good catch, we can do that in another PR if we feel like it.
Yes that works!
There was a problem hiding this comment.
Btw, I don't think this should block the release of this feature, and is something we can add later. But we can discuss more of this with the team if you prefer.
There was a problem hiding this comment.
If I were to make a call I personally would get that in before releasing the feature because 1) it's straight forward enough, but also because 2) right now the commit message is the only way to reason about what it is that you are trying to promote and not being able to see the entire message feels a hindrance to using the feature.
Maybe there's a way to force oclif not to truncate and print out the whole commit message but then that may introduce another issue of the table formatting getting messed up.
Anyways open to discussion for sure!
There was a problem hiding this comment.
Ok I said this because this feature was planned to be shipped in the next changelog tomorrow, as we thought there was not going to be more changes. I can try to get it done before that, but with that + reviewing it (and we are still in code review in other PR'S) we probably don't get to the timeline.
I can propose moving this to next changelog as well.
There was a problem hiding this comment.
Gotcha — yeah let's focus on getting the current outstanding PRs turned around and merged, and then we can chat about the changelog and when it goes out.
| @@ -88,7 +88,8 @@ export default class CommitList extends BaseCommand<typeof CommitList> { | |||
| }, | |||
| commit_message: { | |||
| header: "Commit message", | |||
| get: (entry) => entry.commit_message?.trim(), | |||
| get: (entry) => | |||
| entry.commit_message ? entry.commit_message.trim() : "", | |||
There was a problem hiding this comment.
Yep that makes sense.
One related question though — what happens with a really long commit message? In the screenshots above, it looks like we are doing truncation and I'm guessing that's automatically done by oclif?
francoborr
deleted the
franco-kno-4537-cli-add-knock-commit-list-command-in-cli
branch
Description
Adds support for using
knock commit listcommand, which lists all commits for a given environment.Allowed flags:
--promoted (or --no-promoted): Shows all promoted/unpromoted commits for a given environment.
--environment
--json
--limit
--after
--before
Tasks
KNO-4537
Screenshots