Simple template to create ticket-based bookmarks

[nachtjasmin]

At work, I'm using Closes trailers to link to JIRA tickets. Although there's nothing wrong with the default bookmarks, collaboration is usually easier with "proper" named bookmarks/branches.

With the introduction of jj 0.31 and it's git_push_bookmark template, I can now easily name my bookmarks after the ticket they're closing.

The template below is verifying whether there's exact one ticket linked to this change and if so, uses that together with a short suffix to distinguish multiple changes for the same ticket.

Excerpt from my config.toml.

[templates]
git_push_bookmark = '''
if(
  trailers.filter(|t| t.key() == "Closes").len() != 1,
  "change-" ++ change_id.short(),
  concat(trailers.filter(|t| t.key() == "Closes").map(|t| t.value()).join(""), "-", change_id.shortest(4))
)
'''

The template can optionally be shortened using aliases, but that's a task I'd leave up to the reader.

[lf-]

SICK!! I think I need to figure out a way to do regexes because I have JIRA style ticket IDs at work and conventionally these go at the start of commit messages, so I need to write a feature request about that.

Filed: #6893

[joneshf]

I'm in a similar boat as you. So I'm rooting for your work here!

Until then, I'm going to try out @nachtjasmin's workflow of using trailers, and see how it is. Relatedly, thanks for sharing this template @nachtjasmin! This has been a rough edge I've been trying to find a solution for, and I think your template might work for me!

[chennemann]

please do share if you find a solution. I'll have a look at this as well now that I know something like that is possible in principle :)

[joneshf]

There's been some progress here.

• 0.33.0's String.match lets us take a Jira Issue at the start of a description and turn that into a bookmark:

  [templates]
  git_push_bookmark = """
    separate(
      "/",
      "joneshf",
      description
        .match(regex: "[[:upper:]]+-[[:digit:]]+[[:blank:]]+")
        .trim(),
      change_id.short(),
    )
  """

  This would let us take a description like: VGI-171 Do the thing! and turn it into a bookmark like joneshf/VGI-171/osvtwpxxtozt. This also supports bookmarks that don't have a Jira Issue at the start like: Do the thing! turns into joneshf/osvtwpxxtozt.

• 0.34.0's String.replace lets us extend that further to include the rest of the description:

  [template-aliases]
  "first_line_suffix(description)" = """
    description
      .first_line()
      .remove_prefix(jira_issue_prefix(description))
      .lower()
      .replace(regex:"[[:^word:]]", "-")
      .replace(regex:"-+", "-")
      .replace(regex:"^-|-$", "")
  """
  
  "jira_issue_prefix(description)" = """
    description
      .match(regex:"^[[:upper:]]+-[[:digit:]]+[[:blank:]]+")
      .replace(regex:"[[:blank:]]+", "")
  """
  
  [templates]
  git_push_bookmark = """
    truncate_end(
      244,
      separate(
        "/",
        "joneshf",
        jira_issue_prefix(description),
        first_line_suffix(description),
      ),
    )
  """

  Given some assortment of changes:

  $ jj log --no-graph --revisions='os | vp | w' --template='"change_id: " ++ pad_end(2, change_id.shortest()) ++ " description: " ++ json(description.first_line()) ++ "\n"'
  change_id: vp description: "  \"delete\" this-later-!     "
  change_id: w  description: "Do this and/or that"
  change_id: os description: "VGI-171 Do the thing!"
  

  We can have the bookmarks be generated to human readable names:

  $ jj git push --change='os | vp | w' --dry-run
  Creating bookmark joneshf/delete-this-later for revision vpwotynooquo
  Creating bookmark joneshf/do-this-and-or-that for revision wuxtsklqvupn
  Creating bookmark joneshf/VGI-171/do-the-thing for revision osvtwpxxtozt
  Changes to push to origin:
    Add bookmark joneshf/delete-this-later to 756374db6ea6
    Add bookmark joneshf/do-this-and-or-that to 44e404ecc14a
    Add bookmark joneshf/VGI-171/do-the-thing to ed484cf3a1e9
  Dry-run requested, not pushing.
  

For me, this is exactly what I wanted. Huge thanks to @lf- and @gechr for getting these features in!

[nachtjasmin]

That’s brilliant!! Thanks for sharing! ☺️