Skip to content
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

feat: add pull_description to placeholders #409

Merged
merged 3 commits into from
Jan 22, 2024

Conversation

jschmid1
Copy link
Contributor

@jschmid1 jschmid1 commented Jan 22, 2024

This allows the user to copy the original pull request description to the backported PR. This can be helpful if the body contains links to ticketing systems, related documents etc.

Example usage:

          pull_description: |-
            Automated backport to `${target_branch}`, triggered by a
label in #${pull_number}.

            Original Description:
            ${pull_description}

@korthout
Copy link
Owner

korthout commented Jan 22, 2024

Thanks @jschmid1! I love the idea and implementation! 🚀

Two small things:

  • Let's rename this to pull_description to align with the placeholders that access data from the original pull request. I see that this can be somewhat confusing as the input is also named pull_description, but they are different concepts. Additionally, documentation should help resolve this.
  • Let's adjust align the documentation about the placeholder with the others

This allows the user to copy the original pull request description
to the backported PR. This can be helpful if the body contains
links to ticketing systems, related documents etc.

Example usage:

yaml
```
          pull_description: |-
            Automated backport to `${target_branch}`, triggered by a
label in #${pull_number}.

            Original Description:
            ${pull_description}
```
@jschmid1 jschmid1 force-pushed the feat/pull_description_body branch from a504725 to ba84c7a Compare January 22, 2024 16:27
@jschmid1 jschmid1 changed the title feat: add original_description to placeholders feat: add pull_description to placeholders Jan 22, 2024
@jschmid1
Copy link
Contributor Author

done @korthout

Aligns the new pull_description placeholder description with the
description of the other placeholders.

Also adds the body wording which is used by GitHub's API.
Copy link
Owner

@korthout korthout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great contribution @jschmid1! 🙌 Thanks!

I've made a quick adjustment of the docs the way I like it 😄 I assume that's fine with you.

@korthout korthout merged commit 8546a41 into korthout:main Jan 22, 2024
1 check passed
@korthout
Copy link
Owner

Released in v2.4.0 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants