You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The banner will appear in the modal when clicking [View details] on your plugin.
133
+
134
+
### Configure: Changelog (Optional)
135
+
136
+
Specify a relative path from the plugin root to your changelog:
137
+
138
+
```php
139
+
$gitHubUpdater->setChangelog('CHANGELOG.md');
140
+
```
141
+
142
+
This should be a Markdown file and will populate the Changelog tab when clicking
143
+
[View details] on your plugin. `GitHubUpdater` will use the most recent file from
144
+
GitHub so that a user can review changes before updating.
145
+
146
+
The Markdown to HTML converter currently only supports:
147
+
148
+
- Headers (`#`, `##`, `###`, etc.)
149
+
- Unordered lists (`-`)
150
+
- Blockquotes (`>`)
151
+
- Code blocks (using three backticks to start and end block)
152
+
- Paragraphs
153
+
154
+
And only formats:
155
+
156
+
- Bold text (`**Foo**`)
157
+
- Italic text (`*Foo*`)
158
+
- Code (using single backtick to wrap text)
123
159
124
160
### Add GitHubUpdater (Required)
125
161
@@ -133,4 +169,7 @@ This should be the last method call after `GitHubUpdater` has been configured.
133
169
134
170
## Final Thoughts
135
171
136
-
If you want a deep dive into how `GitHubUpdater` works, check out this [blog post](https://ryansechrest.com/2024/04/how-to-enable-wordpress-to-update-your-custom-plugin-hosted-on-github/).
172
+
If you want a deep dive into how `GitHubUpdater` works, check out this
0 commit comments