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

chore(repo): add autocomment to triage labeled issues #414

Merged
merged 3 commits into from
Jan 29, 2024

Conversation

rwaskiewicz
Copy link
Contributor

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally for affected output targets
  • Tests (npm test) were run locally and passed
  • Prettier (npm run prettier) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe): Repo configuration

What is the current behavior?

When folks open new issues in the repo, they're unaware of the maintenance status. We would like to do a better job at making this clear.

Issue URL: N/A

What is the new behavior?

configure ionitron to automatically label comment any issue that is labeled 'triage' with the repo's current maintenance status. the motivation here is to bring clarity/set expectations to the amount of work that is done in the repo on a day-to-day basis and what its current goals are.

the workflow that ionitron will follow upon applying this patch is as follows:

  1. a new issue is created
  2. ionitron will add the 'triage' label to the issue
  3. upon successful application of the triage label, the comment in this patch will be added to the issue

this pr only adds comments to issues - it does not do the same for pull requests. at this time, ionitron does not have support for labeling with a filter on author (e.g. ionic employees, renovatebot). to avoid unneeded noise in the repo, we choose to only comment on issues for the time being.

Does this introduce a breaking change?

  • Yes
  • No

Other information

Testing is hard to do here before we land it. I've done things like spell checking and ensuring the YAML file is valid, but this is one of those things we have to land/iterate on. It's super similar to what we do for holiday triage on both of our teams, so the risk here (of iteration) should be pretty low

Comment on lines +31 to +33
Thanks for the issue!


Copy link
Contributor Author

Choose a reason for hiding this comment

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

The double newline is necessary here, as it allows ionitron to render this as:

Thanks for the issue!

This project is currently maintained for the purposes of supporting the Ionic Framework.
At this time, only new issues & pull requests that support the Ionic Framework will be prioritized. 
For the latest updates regarding the maintenance status of this project, please see [this section of the project's README](https://github.com/ionic-team/stencil-ds-output-targets#maintenance-status)

Otherwise, with only one newline in the yaml, we'd see the first item and the second item scrunched together:

Thanks for the issue!
This project is currently maintained for the purposes of supporting the Ionic Framework.
At this time, only new issues & pull requests that support the Ionic Framework will be prioritized. 
For the latest updates regarding the maintenance status of this project, please see [this section of the project's README](https://github.com/ionic-team/stencil-ds-output-targets#maintenance-status)

.github/ionic-issue-bot.yml Outdated Show resolved Hide resolved
.github/ionic-issue-bot.yml Outdated Show resolved Hide resolved
rwaskiewicz and others added 3 commits January 29, 2024 08:03
configure ionitron to automatically label comment any issue that is
labeled 'triage' with the repo's current maintenance status. the
motivation here is to bring clarity/set expectations to the amount of
work that is done in the repo on a day-to-day basis and what its current
goals are.

the workflow that ionitron will follow upon applying this patch is as
follows:
1. a new issue is created
2. ionitron will add the 'triage' label to the issue
3. upon successful application of the triage label, the comment in this
patch will be added to the issue

this pr only adds comments to issues - it does not do the same for
pull requests. at this time, ionitron does not have support for labeling
with a filter on author (e.g. ionic employees, renovatebot). to avoid
unneeded noise in the repo, we choose to only comment on issues for
the time being.
@rwaskiewicz rwaskiewicz force-pushed the rwaskiewicz/ionitron-maintenance-rep branch from e2804c5 to be9917f Compare January 29, 2024 13:03
@rwaskiewicz rwaskiewicz enabled auto-merge (squash) January 29, 2024 13:03
@rwaskiewicz rwaskiewicz merged commit 5049b9d into main Jan 29, 2024
3 checks passed
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.

3 participants