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

Introduce workflow that automatically closes pull requests #8139

Closed
wants to merge 5 commits into from

Conversation

desrosj
Copy link
Contributor

@desrosj desrosj commented Jan 16, 2025

This introduces a workflow that finds pull requests referencing any fixed tickets in commit messages.

Trac ticket: https://core.trac.wordpress.org/ticket/62817


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@desrosj desrosj self-assigned this Jan 16, 2025
Copy link

github-actions bot commented Jan 16, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props desrosj, swissspidy, peterwilsoncc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@desrosj
Copy link
Contributor Author

desrosj commented Jan 16, 2025

This is difficult to test, however I've tested pretty extensively in my fork.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@peterwilsoncc
Copy link
Contributor

I think the GitHub link in the comment will need to use the full URL for the trac integration in order to show links.

But let me test to be sure:
Trac reference via r prefix: r59656
Trac prefix linked: r59656
GH Hash only: ab4b4eb
GH Link: ab4b4eb

If I am not confused by how the integration works, this should show up as https://core.trac.wordpress.org/ticket/62817#comment:4

Comment on lines +59 to +60
const query = 'is:pr is:open repo:' + context.repo.owner + '/' + context.repo.repo + ' in:body https://core.trac.wordpress.org/ticket/' + ticket;
const result = await github.rest.search.issuesAndPullRequests({ q: query });
Copy link
Member

Choose a reason for hiding this comment

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

Clever!

@swissspidy
Copy link
Member

I think the GitHub link in the comment will need to use the full URL for the trac integration in order to show links.

You mean the full link to the commit hash, not just ${{ github.sha }}?

Copy link
Member

@swissspidy swissspidy left a comment

Choose a reason for hiding this comment

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

I like it!

@desrosj
Copy link
Contributor Author

desrosj commented Jan 17, 2025

Testing one other GH commit link format:

GH Link: ab4b4eb55d14feb74d34647c7aa4eb370dbd87a8

Copy link

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 59661
GitHub commit: 5e74d34

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Jan 17, 2025
@desrosj desrosj deleted the add/pr-cleanup-action branch January 17, 2025 14:03
@desrosj
Copy link
Contributor Author

desrosj commented Jan 17, 2025

@peterwilsoncc It looks like the comment did not make its way to Trac. I think that is likely due to the fact that we're ignoring comments from the GitHub Actions bot to avoid the playground and other comments from being posted on Trac tickets.

I think this is probably fine, but wanted to make sure there are no strong feelings otherwise.

@johnbillion
Copy link
Member

I think that's preferable! Saves unnecessary noise on the ticket.

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.

4 participants