Skip to content

Conversation

YongGoose
Copy link
Member

Resolves #926

Discussion

Before merging this branch, there are a few things I’d like to discuss.

issue opened, close actions are based on the status: xxx label. For example, in GitHub Actions, when an issue is created, it gets labeled with status: new. Then, for issues or PRs labeled with status: waiting-for-feedback checks are performed, and if there’s no further action after a certain period, the issue or PR gets closed.

A good example of this is JUnit5, which is an open-source project I’m very familiar with.
They manage issues and PRs using the status: label, and from my experience, it works well.

I’d like to bring this approach to Baremaps!

WDYT?

@YongGoose
Copy link
Member Author

@bchapuis @CalvinKirs

I would appreciate it if you could check the Discussion section of the PR and leave your feedback 😀

Here is the link to the JUnit5 labels.

You can also experiment with the behavior of the PR in my repository.

@YongGoose YongGoose changed the title Automatically Add new Label to Newly Created Issues and Close Inactive Issues After a Certain Period Automatically Add new Label to Newly Created Issues and Close Inactive Issues and PRs After a Certain Period Feb 1, 2025
pull-requests: write
steps:
- uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9
with:
Copy link
Member

Choose a reason for hiding this comment

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

The messages imply that the Baremaps community provided a feedback and will do the actual work. What about encouraging ownership? See my suggestions below for the messages.

Copy link
Member Author

Choose a reason for hiding this comment

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

That sounds like a great idea.
In fact, the previous messages were from JUnit5, but the revised messages feel more encouraging. 💪🏻

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in 273a92d !

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I guess that JUnit does not need to build a community anymore 😆

stale-issue-label: "status: stale"
stale-pr-label: "status: stale"
stale-issue-message: >
If you would like us to be able to process this issue, please provide the requested information.
Copy link
Member

Choose a reason for hiding this comment

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

This issue has been inactive for a while. If you’re still interested, let us know how we can help! Our community is small, and we need contributors like you. If we don’t hear back, we may close it, but you’re always welcome to reopen it. Let’s build this together! 🚀

If you would like us to be able to process this issue, please provide the requested information.
If the information is not provided within the next 2 months, we will be unable to proceed and this issue will be closed.
close-issue-message: >
Closing due to lack of requested feedback.
Copy link
Member

Choose a reason for hiding this comment

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

Closing this issue due to inactivity. If you’re still interested, let us know! Our community is small, and we need contributors like you. If you provide more details or take the lead on a solution, we’ll be happy to re-open it. Let’s build this together! 🚀

close-issue-message: >
Closing due to lack of requested feedback.
If you would like to proceed with your contribution, please provide the requested information and we will re-open this issue.
stale-pr-message: >
Copy link
Member

Choose a reason for hiding this comment

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

This PR has been inactive for a while. If you’re still working on it, let us know how we can help! Our community is small, and we need contributors like you. If we don’t hear back, we may close it, but you’re always welcome to reopen it. Let’s build this together! 🚀

If you would like us to be able to process this pull request, please provide the requested information or make the requested changes.
If the information is not provided or the requested changes are not made within the next 2 months, we will be unable to proceed and this pull request will be closed.
close-pr-message: >
Closing due to lack of requested feedback.
Copy link
Member

Choose a reason for hiding this comment

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

Closing this PR due to inactivity. If you’d like to continue, let us know! Our community is small, and we need contributors like you. Feel free to re-open this PR or submit a new one when you’re ready. Let’s build this together! 🚀

Copy link

sonarqubecloud bot commented Feb 1, 2025

@bchapuis bchapuis merged commit 4212c78 into apache:main Feb 1, 2025
10 checks passed
@bchapuis
Copy link
Member

bchapuis commented Feb 1, 2025

Merged! thanks a lot for these gh actions and for the quality of these contributions 🚀

@YongGoose
Copy link
Member Author

@bchapuis

Thank you for checking so quickly!
If you have time, could you also take a look at the PR description?

If an issue arises, the GitHub Action will automatically apply a status: new label to the issue, so we should consider it :)

@bchapuis
Copy link
Member

bchapuis commented Feb 1, 2025

Sorry, I'm not sure to understand. Can you provide me a pointer for the PR description?

@YongGoose
Copy link
Member Author

YongGoose commented Feb 1, 2025

Sorry, I'm not sure to understand. Can you provide me a pointer for the PR description?

I think JUnit 5's labels could be a good reference!

I also created the status: new label in my personal repository.
As a result, GitHub Actions automatically applied the status: new label.

To summarize my question: The close-inactive-issues.yml and label-opened-issues.yml workflows rely on status:xxx labels for their process. That's why I'm proposing to create these status:xxx labels.

status: xxx refers to labels that start with status:.

Since we've already merged these workflows, there are certain labels that we must create. I'll explain in more detail in the comments below.

Copy link
Member Author

@YongGoose YongGoose left a comment

Choose a reason for hiding this comment

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

If there's anything unclear in my comment, feel free to leave a comment! :)

steps:
- uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9
with:
only-labels: "status: waiting-for-feedback" # only consider issues and PRs with this label
Copy link
Member Author

Choose a reason for hiding this comment

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

This part checks for issues and PRs that are labeled with status: waiting-for-feedback.
So, we need to create the status: waiting-for-feedback label.

issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ["status: new"]
Copy link
Member Author

Choose a reason for hiding this comment

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

This part of the workflow automatically applies the status: new label when a new issue is opened.
Therefore, we need to create the status: new label.

Comment on lines +19 to +20
stale-issue-label: "status: stale"
stale-pr-label: "status: stale"
Copy link
Member Author

Choose a reason for hiding this comment

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

This part of the code checks issues and PRs in a stale state using this label.
Therefore, we should create the status: stale label.

@bchapuis
Copy link
Member

bchapuis commented Feb 1, 2025

Thank you for the clarification. I created the new, waiting-for-feedback, and stale labels.

@YongGoose
Copy link
Member Author

YongGoose commented Feb 1, 2025

Thank you for the clarification. I created the new, waiting-for-feedback, and stale labels.

Thank you!

However, the label names need to be accurate. Could you please change them to the following names?

  • status: new
  • status: waiting-for-feedback
  • status: stale

@bchapuis
Copy link
Member

bchapuis commented Feb 1, 2025

Ok, got it. I'm discovering this part of gh.

@YongGoose
Copy link
Member Author

Ok, got it. I'm discovering this part of gh.

It seems like you're doing great already!
Thank you for considering my feedback.

Have a great day!

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.

Automatically Add new Label to Newly Created Issues and Close Inactive Issues After a Certain Period

2 participants