Where can I find the commit description

[hawlcat]

Hi there,

For committing, a commit message could be input including a title and description. After committing, I can see the commit title, but cannot find the description. Just wondering it is lost or just hidden somewhere? If hidden, where can I find this description because usually put lots of update information there so it is easy for other people to get the update idea at the first glance.

thanks

[ianhi]

Hi @hawlcat, I don't think this is currently possible from the extension UI, but this would a nice improvement.

It looks as though the commit message is making it to the frontend in the ISingleCommitInfo but not in the ISinglePastCommitInfo and the latter is used for rendering the items in the history tab.

jupyterlab-git/src/tokens.ts

Lines 638 to 644 in 0e1e697

	export interface ISingleCommitInfo {
	commit: string;
	author: string;
	date: string;
	commit_msg: string;
	pre_commit: string;
	}

jupyterlab-git/src/components/SinglePastCommitInfo.tsx

Line 60 in 3c28978

export interface ISinglePastCommitInfoState {

[ianhi]

Actually maybe I was confused. It seems that commit_msg is only the commit title, not the body of the commit message. Perhaps ISingleCommitInfo will need to be modified to also contain the commit message body. And then a
{this.props.commit.commit_body} should be added here:

jupyterlab-git/src/components/PastCommitNode.tsx

Lines 107 to 111 in 4efb0a7

	<div className={branchWrapperClass}>{this._renderBranches()}</div>
	<div className={commitBodyClass}>
	{this.props.commit.commit_msg}
	{this.state.expanded && (
	<SinglePastCommitInfo

Though perhaps it's best to leave ISingleCommitInfo without the commit message to reduce the size of packets being passed between the front and backend. Instead the backend function detailed_log should return all of the details of a commit, including the body of the commit:

jupyterlab-git/jupyterlab_git/git.py

Line 449 in 3c28978

async def detailed_log(self, selected_hash, current_path):

Then the frontend calls detailed_log here:

jupyterlab-git/src/components/SinglePastCommitInfo.tsx

Line 134 in 4efb0a7

const log = await this.props.model.detailedLog(this.props.commit.commit);

[ianhi]

I marked this a Good first issue, because I think that my final proposal shouldn't require any significant changes to data flow. But anyone feel free to clear that if this is harder than I think

[fcollonval]

Closing as resolved by #1134