Automation Proposal: GHA-add-issue-to-project

[100AutomationsProject]

Your Name

Ava Li

Your Email

[email protected]

Overview: describe the kind of repetitive thing you have to do and the benefit of automating it?

Often times, when an issue is created, it should move into the project board, where it can be organized. If an issue is not moved into the project board, or worse, moved into the wrong project board or wrong column, development and work on a project is stalled. By automatically placing newly created issues into an appropriate place, errors are lessened, and project workflow can be focused less on organizing the project, and more on delivering a product.

Ownership of Idea

I will be working on this automation myself

Current State: Is this just an idea, or has any work already been done to build it?

The automation is currently finished.

Languages or frameworks used?

yml, javascript

Platform?

GitHub

Automation triggers: What starts it? What's it responding to? Time or event based?

That depends on what trigger the user wants it to be. It is customizable. The automation simply move issues based on a trigger.

Any GHA trigger can technically trigger it, if customized to do so. The current triggers that will cause it to run are:

• issue comment created
• issue comment edited
• issue comment deleted
• issue opened
• issue edited
• issue deleted
• issue transferred
• issue pinned
• issue unpinned
• issue closed
• issue reopened
• issue assigned
• issue unassigned
• issue labeled
• issue unlabeled
• issue locked
• issue unlocked
• issue milestoned
• issue demilestoned

Examples of what this can do, include:

• Place the issue in the 'Dependency' column if the dependency label is added.
• If the issue has the phrase, "Research and Development" in the body, move it into the "R&D" column of the "Research" project.

How much manual or custom input is required?

There needs to be an initial configuration and setup before it can run automatically.

Output: What's the desired result? What do we not want to see?

The desired result is to have the automation be easy to use, setup, and customize. We want to reduce the amount of work that goes into organizing and managing the project board.

Project size: rough estimate of effort and time needed to build it

It can be on-going as additional features are requested.

Stakeholders and Impact - who benefits and how?

Anyone who manages a github project board will benefit. The impact of this is directly proportional to the size of a project.

Resources/Instructions: Has any documentation been created yet?

Yes

Action Items/Research Needed

None. Everything is already set.

Bio of author

• Write Bio - Content Creator: Ava Li Website#503

Health files

• https://github.com/100Automations/GHA-add-issue-to-project/blob/master/CODE_OF_CONDUCT.md
• https://github.com/100Automations/GHA-add-issue-to-project/blob/master/CONTRIBUTING.md
• https://github.com/100Automations/GHA-add-issue-to-project/blob/master/SECURITY.md
• https://github.com/100Automations/GHA-add-issue-to-project/blob/master/README.md
• https://github.com/100Automations/GHA-add-issue-to-project/blob/master/SUPPORT.md
• license

Name of Repo

• https://github.com/100Automations/GHA-add-issue-to-project

[Aveline-art]

Hi @henlatourrette @ExperimentsInHonesty . Thank you so much for this feedback! I have made the corrections as a pull request. Changes can be viewed here. The updated README.md can be viewed here. If needed, the current README can be viewed here. Please let me know if there is anything else that is needed from my end!

[ExperimentsInHonesty]

@Aveline-art I have approved the PR, ill leave it to you to Merge it.

[henlatourrette]

@Aveline-art After you merge those changes, all that remains is to help us make it appear on the 100Automations.org website. In order, to facilitate that we have created a guide for what is required:
https://100automations.org/guides/prep-automation-for-publication.html

Unfortunately, we don't have graphic designers to help us with the logo. Let us know if you want to brainstorm a hacky version similar to what Bonnie has created for "Jekyll Gather Data Types" and "True Github contributors" which you can see on the 100Automations homepage.

Please use the issue template contained in the guide to submit your content.

[Aveline-art]

@henlatourrette Thanks for letting me know the next steps. For the logo, is there a standard 100automations logo? I'm thinking my automation can fall into some 100automations branding or what not?

[Aveline-art]

@henlatourrette

After reviewing the guide on my next steps, I find the page to be a little disorienting. It is hard to make out headings from sub headings, and took me a while to fully understand. For the description I would like to use the intro from the repo:

"If your team uses GitHub project boards to manage your repository's issues, making sure that all issues end up on the right board is crucial. If an issue is not moved into the project board, or worse, moved into the wrong project board or wrong column, development and work on a project is stalled. By automatically placing newly created issues into an appropriate place, errors are lessened, and project workflow can be focused less on organizing the project, and more on delivering a product.

This GitHub Action (GHA), when triggered, is designed to move issues to a specific column based on certain set of criteria such as a specific label, or specific phrase in the issue's body. This will prove helpful for members of a team who manages a project, such as project managers. By design, it abstracts a lot of the configuration into one file, making customization simple for team members who are not adept to coding syntax."

As for the status, I would say it is in development and needs peer review and user testing. That said, I am using it as a beta for CivicTechJobs at the moment. Should this information be included in the description?

[henlatourrette]

Hey @Aveline-art, we're working on a logo with Bonnie to help you out with that part. You can take a look at it here - slide number 6 :

https://docs.google.com/presentation/d/1D6GoIlHxmFqiMLeY2XXbLQY-al53xdRtBihj6FM2IhE/edit#slide=id.g11471637adc_0_60

Also, we noticed that your description has 900+ characters which is much more than the longest one we have right now on the site (536 characters). Do you think you can shrink it down a little bit? I think that the second paragraph has the key information about it. For full details, there will always be the ReadMe page.

Regarding your questions about the current status, this should make it easier for you to pick - we don't have "needs user testing" as an option.

Possible Status of project: (must pick one)

• In Use And Ready To Deploy
• In Use and Needs Further Development
• In Use And Being Refactored
• Ready To Deploy
• In Development
• Ready For Development
• In Ideation
• Abandoned

Needs Help status: (can pick as many as apply)

• Needs Maintenance
• Needs Support For Users
• Needs Refactoring
• Needs Documentation
• Needs Peer Review
• Needs To Be Built
• Needs To Be Researched
• Needs Advice
• Needs Takeover
• Advice Needed

If you're using it on CivicTechJobs right now, it could say "As seen on CivicTechJobs" at the botton.

[ExperimentsInHonesty]

@Aveline-art
Here is the image we ended up making. Let us know what you think.

@henlatourrette fyi

[Aveline-art]

@ExperimentsInHonesty It looks great! Kudos to the team member who created it!

---

I'll collect all the next step requirements below so that I can edit it all in once place:

Logo

See here.

Description

This GitHub Action (GHA), is designed to move issues to a specific column based on criteria such as a specific label, or specific phrase in the issue's body. This will prove helpful for members of a team who manages a GitHub project board, such as project managers, by lessening errors and organizing workflow. By design, it abstracts a lot of the configuration into one file, making customization simple for team members who are not adept to coding syntax.

Status

Status of project: (must pick one)

• In Use And Ready To Deploy
• In Use and Needs Further Development
• In Use And Being Refactored
• Ready To Deploy
• In Development
• Ready For Development
• In Ideation
• Abandoned

Needs Help status: (can pick as many as apply)

• Needs Maintenance
• Needs Support For Users
• Needs Refactoring
• Needs Documentation
• Needs Peer Review
• Needs To Be Built
• Needs To Be Researched
• Needs Advice
• Needs Takeover
• Advice Needed

Extra

Beta currently in use at CivicTechJobs.

[ExperimentsInHonesty]

@Aveline-art We have added your automation to the 100automations website, but it looks like the part where it displays the project it's in use on is hard coded with a logo right now. If you can work with the designers on CTJ to get their favicon, we can use that, and we will try to get some developers to fix our code so that it shows up properly on your card.

[Aveline-art]

@ExperimentsInHonesty Certainly! The favicon can be found here. The team can either use the link as is or import the asset into the 100auto repo.

[henlatourrette]

Thank you @Aveline-art! With this last update, I think we can consider it published and the process finished.

@ExperimentsInHonesty for the "as seen in" part I believe it should be considered as a bug on our website and treated separately. Or at least, we could leave it ready on the automation card but work with developers to fix it independently.

• Issue created to fix this "as seen in" bug >> Fix "As seen on" to display logos dynamicaly  Website#507