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

Issue #16: Enhancing the "Using Subversion" Page: Adding a 'Troubleshooting' Section #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

WPLake
Copy link

@WPLake WPLake commented Jul 14, 2024

@WPLake WPLake force-pushed the issue-16_using-subversion-page_new-troubleshooting-section branch from 32f8648 to db6d7c5 Compare August 5, 2024 05:58
Copy link
Contributor

@frantorres frantorres left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution!

I'd just like to ask you to move this new section to the end of the document (as I think the information in the "Notes" and "See also" sections is important for everyone to read before they even encounter problems).

Copy link

@ironprogrammer ironprogrammer left a comment

Choose a reason for hiding this comment

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

Thanks for suggesting this update, @WPLake! 🙌

I agree the new section would be helpful when something unexpected occurs during deployment, and with the other suggestion of moving it to the bottom of the doc. This could also inspire other contributors to share common problems.

The changes I suggest here are from my perspective of having read lots of WP docs, but no hard feelings if you don't agree. This is a comment only, as I don't wish to block getting this update into the handbook. Thanks again!

Comment on lines +248 to +252
This issue occurs on the client's (your) side when the server (wordpress.org) takes a very long time to process the input.

Usually, it happens only with large plugins that contain hundreds of files. For example, contributors to the Gutenberg plugin (which is a part of WordPress but is also available as a plugin) [have faced](https://github.com/WordPress/gutenberg/issues/55295) this issue.

To solve this problem, you need to add a special timeout-increasing option to the commit command:

Choose a reason for hiding this comment

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

Suggested change
This issue occurs on the client's (your) side when the server (wordpress.org) takes a very long time to process the input.
Usually, it happens only with large plugins that contain hundreds of files. For example, contributors to the Gutenberg plugin (which is a part of WordPress but is also available as a plugin) [have faced](https://github.com/WordPress/gutenberg/issues/55295) this issue.
To solve this problem, you need to add a special timeout-increasing option to the commit command:
This issue can occur when the SVN repository takes a long time to process uploaded files, particularly with large plugins that contain hundreds of files. The default timeout for SVN in the plugin repository is 10 minutes (600 seconds).
To work around this issue, you can increase SVN's timeout during commit with the `servers:global:http-timeout` option, passing it a timeout in seconds. For instance, to set the timeout to 15 minutes:

This suggestion adds in some technical details from the PR that sparked this contribution, but puts less focus on that particular issue.

The other part of the referenced PR that relates to reducing processing time is combining the updates to trunk and the new tag into one commit, but this is already documented in the Best Practices section.

Comment on lines +258 to +259
In this command, 900 is the number of seconds. Using this trick, you'll be able to bypass the timeout issue.

Choose a reason for hiding this comment

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

Suggested change
In this command, 900 is the number of seconds. Using this trick, you'll be able to bypass the timeout issue.

Removing this bit, as this would be covered by the previous text suggestion.

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.

Enhancing the "Using Subversion" Page: Adding a 'Troubleshooting' Section
3 participants