Skip to content

Commit 58640fd

Browse files
committed
Updated MD files.
1 parent f88f903 commit 58640fd

File tree

2 files changed

+62
-16
lines changed

2 files changed

+62
-16
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Make the changes to your forked repository.
55
* Ensure you use LF line endings - no crazy windows line endings. :)
66
* When committing, reference your issue (#1234) and include a note about the fix.
7-
* Push the changes to your fork and submit a pull request on the **master branch** of the GitHub to WordPress Deploy Script repository.
7+
* Push the changes to your fork and submit a pull request on the **master branch** of the GitHub to WordPress.org Deployment Script repository.
88

99
At this point you're waiting on me to merge your pull request. I'll review all pull requests, and make suggestions and changes if necessary.
1010

README.md

Lines changed: 61 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
11
# GitHub to WordPress.org Deployment Script
2+
3+
A simple deploy script to push any branch from your GitHub repository to your WordPress.org plugin SVN for a new release.
4+
5+
## Overview 🔔
6+
27
Releasing WordPress plugins can be quite a chore so a script that handles all of that for you is very helpful. This allows you to do that.
38

4-
This script is dummy proof. No need to configure anything. Just run the script and follow the instructions as you go along.
9+
This script is dummy proof and you do NOT need to configure anything so long as you have setup your GIT and SVN login globally. This is to insure you have write permission. Otherwise you will be asked to login every step of the way a GIT or SVN command runs before it proceeds.
10+
11+
Just run the script and follow the instructions as you go along and your new release will be up in no time.
12+
13+
14+
### Is This Free?
15+
16+
Yes, it's free. But here's what you should _really_ care about:
17+
* Steps are easy to understand.
18+
* Does everything for you.
19+
20+
### What's the Catch?
521

6-
## Features
22+
This is a non-commercial script. As such:
23+
24+
* Development time for it is effectively being donated and is therefore, limited.
25+
* Support inquiries may not be answered in a timely manner.
26+
* Critical issues may not be resolved promptly.
27+
28+
Please understand that this repository is not a place to seek help. Use it to report bugs, propose improvements, or discuss new features.
29+
30+
## Features ✔️
731
* Supports HTTPS and SSH connections.
832
* Specify your remote when fetching from your repository.
33+
* Supports Windows if you have TortoiseSVN installed.
934

1035
## What does the script do?
1136
This script will pull down your remote GIT and SVN repositories, tag a release using the branch you specify, and commit everything to WordPress.org.
@@ -14,10 +39,9 @@ As you run the script it will asks questions at certain points to setup the proc
1439

1540
When it comes to ask for which version you want to release it checks if it has already been tagged before continuing the rest of the script.
1641

17-
It also removes unwanted files that should not be included with the release.
18-
19-
The following file types are removed from the parent directory of the plugin location.
42+
The following file types are removed from the parent directory of the plugin location to keep it clean from any development/repository files that the plugin does not need with the release.
2043

44+
```
2145
* .git
2246
* .github
2347
* tests
@@ -46,33 +70,55 @@ The following file types are removed from the parent directory of the plugin loc
4670
* apigen.neon
4771
* screenshot-*.jpg
4872
* screenshot-*.png
73+
```
4974

5075
Don't see a file that needs to be removed. Create an issue and let me know which file or folder that needs to be removed.
5176

77+
78+
## Requirements ✅
79+
5280
To use the script you must:
5381

5482
1. Host your code on GitHub.
5583
2. Already have a WordPress.org SVN repository setup for your plugin.
5684
3. Have both GIT and SVN setup on your machine and available from the command line.
5785

58-
## Getting Started
59-
60-
All you have to do is download the script release.sh from this repository and place it in a location of your choosing. Can be run from any location.
6186

6287
## Usage
6388

64-
1. Open up terminal and cd to the directory containing the script.
89+
1. Open up terminal/command prompt and change to the directory containing the script.
6590
2. Run: ```sh release.sh```
6691
3. Follow the prompts.
6792

93+
94+
## Feedback ⭐
95+
96+
GitHub to WordPress.org Deployment Script is released freely and openly. Feedback or ideas and approaches to solving limitations in GitHub to WordPress.org Deployment Script is greatly appreciated.
97+
98+
99+
#### Reporting Issues 📝
100+
101+
If you think you have found a bug in the script, please [open a new issue](https://github.com/seb86/github-to-wordpress-deploy-script/issues/new) and I will do my best to help you out.
102+
103+
104+
## Contribute
105+
106+
If you or your company use GitHub to WordPress.org Deployment Script or appreciate the work I’m doing in open source, please consider supporting me directly so I can continue maintaining it and keep evolving the project. It's pretty clear that software actually costs something, and even though it may be offered freely, somebody is paying the cost.
107+
108+
You'll be helping to ensure I can spend the time not just fixing bugs, adding features, releasing new versions, but also keeping the project afloat. Any contribution you make is a big help and is greatly appreciated.
109+
110+
Please also consider starring ✨ and sharing 👍 the repo! This helps the project getting known and grow with the community. 🙏
111+
112+
If you want to do a one-time donation, you can donate to:
113+
- [My PayPal](https://www.paypal.me/codebreaker)
114+
- [BuyMeACoffee.com](https://www.buymeacoffee.com/sebastien)
115+
116+
Thank you for your support! 🙌
117+
118+
68119
## Final Notes
69120

70-
- This will checkout the remote version of your GitHub Repo.
121+
- This will checkout the remote version of your GitHub repository.
71122
- Committing to WordPress.org can take a while so be patient.
72-
- I have tested this on Mac only.
73123
- Use at your own risk of course :smile:
74124

75-
### Support Sébastien's Open Source Projects!
76-
If you'd like me to keep producing free and open source software or if you use this script and find it useful then please consider [paying for an hour](https://www.paypal.me/CodeBreaker/100eur) of my time. I'll spend two hours on open source for each contribution.
77-
78-
You can find more of my Free and Open Source scripts on [GitHub](https://github.com/seb86)

0 commit comments

Comments
 (0)