--from-context doesn't include footers

[muja]

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

 ERROR git_cliff > Template render error:
Variable `commit.footers` not found in context while rendering 'template'

Steps To Reproduce

You can test with my repository's template at https://github.com/muja/unrar.rs, for example where I use footers.

git cliff --context gives footers, however

git cliff --context | git cliff --context --from-context - has no footers.

Expected behavior

footers are read from context

Screenshots / Logs

No response

Software information

• Project version: 2.5.0

Additional context

Possibly other values are also missing? I haven't fully compared the contexts

[orhun]

Good find! This is due to footers being serialized manually:

git-cliff/git-cliff-core/src/commit.rs

Line 427 in 08e761c

commit.serialize_field("footers", &SerializeFooters(self))?;

git-cliff/git-cliff-core/src/commit.rs

Lines 405 to 419 in 08e761c

	/// A wrapper to serialize commit footers from an iterator using
	/// `Serializer::collect_seq` without having to allocate in order to
	/// `collect` the footers into a new to `Vec`.
	struct SerializeFooters<'a>(&'a Commit<'a>);
	impl Serialize for SerializeFooters<'_> {
	fn serialize<S>(
	&self,
	serializer: S,
	) -> std::result::Result<S::Ok, S::Error>
	where
	S: Serializer,
	{
	serializer.collect_seq(self.0.footers())
	}
	}

We simply need to add a Vec<Footer> field to Commit for enabling the deserialization.

I might get to it soon, marking it as good first issue in case someone wants to work on it :)

[muja]

FYI I compared the diffs between git cliff --context and git cliff --context | git cliff --context --from-context -. These are the differences:

1. missing fields: footers, body, breaking_description, breaking
2. conventional flipped from true to false

[orhun]

Thanks for the comparison! It will definitely come in handy while working on the fix.

[dqkqd]

@orhun
Hi, I'm trying to fix this issue. Surely, adding footers into Commit is an easy fix for this.

But as @muja mentioned above, body, breaking, and some other fields were missing during reading and writing context. I think a proper fix should address them as well.

Looking at the serialization code, I found that we are trying to convert some fields from conv into Commit. For example, assigning message from conv to Commit, and since they are not identical, we lose data after converting to context.

Maybe we should retain some information so that after writing to context, we can read it back without any loss of data.
message should be the good one, since we can create conv from it. Or we can add another field (e.g raw_message) ?

git-cliff/git-cliff-core/src/commit.rs

Lines 221 to 224 in 08e761c

	pub fn into_conventional(mut self) -> Result<Self> {
	match ConventionalCommit::parse(Box::leak(
	self.message.to_string().into_boxed_str(),
	)) {

What do you think?

[orhun]

Hey @dqkqd, that sounds reasonable 👍🏼 I'm looking at your PR right now :) Thanks