Issue templates: specify a project

[mikermcneil]

User story

As a GitHub user defining an issue template, I want to specify a project for that issue template, just like I can specify labels, assignees, and so forth.

Depth

For my use case, it's not a big deal to be able to define multiple projects, or even a specific column within the project. (The project's default column works ok. Being able to specify a column would be nice, but it's not essential to get value from this.)

Screenshot

Use case

Context: At Fleet, we are active users of GitHub Projects, and we're trying our best to make it work. We've invested a lot of time in it, have grown to 21 people, and are now about to make a more permanent decision on whether to stick with projects. We would like to!

Regardless, we are quite committed to using Github issue templates, and use them for everything from file bugs to employee onboarding to closing enterprise sales, and more. We are getting a lot of value from issue templates!

Questions?

Would you please reach out to me via email, LinkedIn message, or a public tweet to twitter.com/mikermcneil? (i might not see DMs)

Thank you!

[gabrielbdornas]

Hello @mikermcneil, yesterday I was just watching this vídeo to figure out how the GitHub project works and start to create some tests in one of my repositories. Immediately I created issues templates and tried to use the existent syntax to link them with my brand new project, just like labels and assignees. Good to know that you have the same insight! Taking care of ours projects in just one place is a really good idea and Github is showing itself a perfect option, isn't it?

[numbsafari]

@mikermcneil would be curious to know if you all have stuck with it and if you'd be willing to share some insights into what is/is not working for you all.

It would be great to use GH Issue Templates for this, and/or have the ability to create a "default project" for a repo, so that any issues created in the repo are automatically added to that project. Sucks to have to burn Actions minutes on stuff like that.

[liushooter]

good idea ！

[omnika-foundation]

This is a missing albeit necessary feature.

[tomhuds]

Yep can we get this enabled ASAP please?

[Khamida-schemeverge]

Totally agreed!!! Very much needed feature!!!!

[sarpulas]

This would be extremely useful for moving our automations entirely to github projects

[ashrafguitoni]

Would be very useful to have, indeed.

[dmorrill]

I would use this, was looking for how to do this today

[simonebeets]

I'm hoping that this feature is implemented as I just looked around to see if there was a way to set a project to an issue template now and found this discussion.

[shamitpatel]

would be a truly useful feature.

[nicolasvienot]

I was also looking for a way to do this. I believe this would be an excellent addition 👍

[xrdavies]

Cannot wait for this feature! We are moving our community management on GitHub. Right now, assigning the issue to a specific project is blocking us.

[Khamida-schemeverge]

For someone who does the Onboarding using GitHub a lot, this feature is essential. The templates are already great but choosing the project every time is tiresome and sometimes I forget to assign it to the right project when I need to urgently create multiple issues.
For the sake of the smooth onboarding and other operations please make this happen in 2023! Thank you!

[hiroakiito2002]

Hi folks, happy new year.

Total overkill, but I've managed to achieve this request using Actions, so I thought I'd share it.

I've used the following script to add any issues created in a repo to a single project. You can replicate the script and secret to replicate the feature in multiple repo case:

name: Add issues to project

on:
  issues:
    types: [opened]

jobs:
  add-to-project:
    name: Add issue to project
    runs-on: ubuntu-latest
    steps:
      - uses: actions/add-to-project@v0.4.0
        with:
          project-url: https://github.com/users/<user id>/projects/<project id>
          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

Hope this helps!

[gabrielbdornas]

Awesome! I've just implemented this idea and it works fine! Thanks!

[Techboidesign]

There seems to be now a section called Workflows directly embedded to the Project folder
There you can trigger actions like if new project + label = move to board

[gabrielbdornas]

Interesting!

Unfortunately, this option didn't appear to me yet.

[Tilation]

It's missing for me too

[Khamida-schemeverge]

missing here as well

[yngvark]

I have it. It is exactly what I need. However, I have many repositories, and right now I can duplicate this workflow only 4 times.

When I have reached the maximum number of workflows, the duplicate-button is disabled with the hover-text

maximum number of workflows reached. Delete a workflow to continue.

I really hope GitHub can increase this number!

[BenjaminYde]

Would be a very nice feature!

[kehonda]

https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically

By using this workflow, I was able to achieve this without the ability to add projects from issue templete.
thank you.

[dt-undairstand]

I agree with this demand i'm looking for the same feature, it's uncomfortable to do it manually for each issue created.

[Aarbel]

Agree too to add this feature:

• project AND project's status definition directly from template

[alissontenorio]

Please include this feature

[daltonmainilnutrien]

Adding a comment in support of this feature, would be very useful.

[rkist]

Please I need this!!

[joeppeeters]

I just found out about a new toplevel property you can set in your template definition:

projects (Array or String): This issue will be automatically added to these projects. Can be array of projects or comma-delimited string, e.g. "github/1,github/2"

This is from the documentation drawer which appears when you open the template for editing in the GH web editor. I did not found this in the docs elsewhere.

The project board references are formatted as <org>/<project_id>.

Example .github/ISSUE_TEMPLATE/my-template.yml:

name: MyIssueTemplate
projects: "github/1"
body:
  - ...

[get6]

Yes! this information I was looking for on the web!

[gabrielbdornas]

I just found out about a new toplevel property you can set in your template definition:

projects (Array or String): This issue will be automatically added to these projects. Can be array of projects or comma-delimited string, e.g. "github/1,github/2"

This is from the documentation drawer which appears when you open the template for editing in the GH web editor. I did not found this in the docs elsewhere.

The project board references are formatted as <org>/<project_id>.

Example .github/ISSUE_TEMPLATE/my-template.yml:

name: MyIssueTemplate
projects: "github/1"
body:
  - ...

This new feature is awesome! I also found this github action to add project to issues. I started to use this action before the new issue template feature and think have this two options is perfect.

[jehtee]

Is there a special trick? i cannot get this to work, and I have tried every possible variation of project path for the "projects: " property I can think of and the new issues i create from the relevant template do not have a default project set.

Other properties like 'label' and 'assignee' do read from the front matter correctly. But not 'project'

[vishalchangrani]

same

[sharmi]

I too tried multiple iterations and finally figured it out.

If your project url is https://github.com/orgs/OrgName/projects/1

Then you have to specify the following in the Issue Template

name: MyIssueTemplate
projects: "OrgName/1"
body:

This works for me

[jehtee]

Here is my issue created using a template with that front matter:

And here is the template code:

And here is the address bar show the project path:

As you can see from the first image, this template code is not assigning new issues to the identified project.

I'm sure that I'm doing something wrong, but I just cannot see what it is.

[traumverloren]

Sorry for the confusion around this! This feature is only supported in the yaml based issue forms. More info: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

[codeagencybe]

@jehtee

Did you manage to get this working with that frontmatter for projects?
I have exactly the same problem.
All other fields like assignee, labels, ... are mapping totally fine, but projects is always empty.

I have checked and compared the orgname like 50x and it is 100% identical, yet it does not map.
Feels like there is something wrong at Github side like a bug, because I don't I don't see anything else possible.

[traumverloren]

Sorry for the confusion around this! This feature is only supported in the yaml based issue forms. More info: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

[sharmi]

[image: https://user-images.githubusercontent.com/90803118/259155905-6112b11c-2aa3-40e7-85ab-54ccd3623865.png] For this project, the id to be specified is projects: "Test-Org/29" This way I am able to successfully add default Projects to my issues.

…

On Fri, Aug 11, 2023 at 1:46 AM Fabio Tielen ***@***.***> wrote: @jehtee <https://github.com/jehtee> Did you manage to get this working with that frontmatter for projects? I have exactly the same problem. All other fields like assignee, labels, ... are mapping totally fine, but projects is always empty. I have checked and compared the orgname like 50x and it is 100% identical, yet it does not map. Feels like there is something wrong at Github side like a bug, because I don't I don't see anything else possible. — Reply to this email directly, view it on GitHub <#9687 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKPKYW3TLR4W5AVW6JY6XTXUU6QJANCNFSM5LLQGI2A> . You are receiving this because you commented.Message ID: ***@***.***>

[codeagencybe]

I have used the correct the path like it is showing for me, but I don't have that /org part?

When I check the URL for my project, it's like this:
https://github.com/users/codeagencybe/projects/18/

So I used "/codeagencybe/18" like:

projects: "/codeagencybe/18"

But it does not work while the path is absolutely correct.

Is this a feature that only works under org repo's?

[sharmi]

You don't need the first forward slash I think. That might be the issue.

…

On Fri, 11 Aug, 2023, 14:30 Fabio Tielen, ***@***.***> wrote: I have used the correct the path like it is showing for me, but I don't have that /org part? When I check the URL for my project, it's like this: https://github.com/users/codeagencybe/projects/18/ So I used "/codeagencybe/18" like: projects: "/codeagencybe/18" But it does not work while the path is absolutely correct. Is this a feature that only works under org repo's? — Reply to this email directly, view it on GitHub <#9687 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKPKYQLC4PVLTLR2QJ3RVTXUXYD5ANCNFSM5LLQGI2A> . You are receiving this because you commented.Message ID: ***@***.***>

[codeagencybe]

I tried with and without /, still no difference.
I think it's something related to organisations only or maybe a bug that's it's only checking for projects in orgs.
Don't know, but it's annoying for sure haha

[rileybroughten]

You can now specify a project in your issue forms! Check out the changelog announcement here. If you have other feedback on issue forms and templates, feel free to drop a note in this discussion 👍

[Daffiw]

Only the finger copy's starts with Jason and Jason package in have isolation modus en .js off that seems too work a little but is see al the time orders chevron did all, this is just a little ✌🏼

[IDrumsey]

@tellisnz Do you know if they're planning on adding support for the Frontmatter md format?

[LBWright]

It's a little frustrating that this isn't supported in the MD templates, since the MD templates are the defaults when a new template is created from the github UI.

[IDrumsey]

Yeah fr, but I did find a solution. Just add the workflow for auto-adding items from the repo - https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically

[aaclayton]

How is this issue treated as complete if it does not support markdown templates?

[JamesRivers]

for non org user accounts, but personal pro. What is the fix here?