Create GitHub Actions workflow for automatic publishing #44
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acelaya
force-pushed
the
publish-workflow
branch
2 times, most recently
from
f148bda
to
984a069
Compare
Closed
acelaya
changed the title
acelaya
force-pushed
the
publish-workflow
branch
from
984a069
to
31fb4f4
Compare
acelaya
commented
Jan 24, 2024
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "hypothesis", | |||
| "version": "0.4.8", | |||
| "version": "0.6.0", | |||
There was a problem hiding this comment.
This was outdated, but it's not really used at the moment.
acelaya
commented
Jan 24, 2024
| uses: 10up/action-wordpress-plugin-deploy@stable | ||
| env: | ||
| SVN_USERNAME: ${{ secrets.WP_SVN_USERNAME }} | ||
| SVN_PASSWORD: ${{ secrets.WP_SVN_PASSWORD }} |
There was a problem hiding this comment.
The secrets have been set
acelaya
force-pushed
the
publish-workflow
branch
from
31fb4f4
to
0b496f0
Compare
acelaya
commented
Jan 24, 2024
| @@ -4,7 +4,7 @@ | |||
| * Plugin URI: https://hypothes.is/ | |||
| * Description: Hypothesis is an open platform for the collaborative evaluation of knowledge. This plugin embeds the necessary scripts in your WordPress site to enable any user to use Hypothesis without installing any extensions. | |||
| * Version: 0.6.0 | |||
| * Requires at least: 6.0 | |||
| * Requires at least: 6.2 | |||
There was a problem hiding this comment.
As far as I can see, many popular plugins support the latest 3 minor versions, which are 6.2, 6.3 and 6.4
acelaya
commented
Jan 24, 2024
README.md
Outdated
Comment on lines
16
to
28
| Follow these steps to publish a new plugin version. | ||
|
|
||
| 1. **Update the package version** in `hypothesis.php`, `readme.txt` and `package.json`, and merge that change into the `main` branch[^1]. We use [Semantic Versioning](https://semver.org/#semantic-versioning-200). | ||
| 2. **Create a tag** pointing at the version-change commit and generate a **new GitHub release** (details follow). Publishing a GitHub release will kick off a GitHub Action that will publish the plugin to wordpress.org | ||
|
|
||
| ### Creating a GitHub release | ||
|
|
||
| Create a [new GitHub release](https://github.com/hypothesis/frontend-shared/releases/new/) with these values: | ||
|
|
||
| 1. _Tag_: Create a new tag for the release, targeting the `main` branch (your just-merged version bump should be at the tip)[^2]. The tag should match the version number, e.g. `v5.2.1`. | ||
| 2. _Title_: Use the tag name. | ||
| 3. Click the `Auto-generate release notes` button to generate release notes and edit as needed. We use [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) formatting.[^3] | ||
| 4. Leave other fields alone/as defaults. |
There was a problem hiding this comment.
I took this from frontend-shared. The only difference is that the version needs to be edited in hypothesis.php and readme.txt.
acelaya
force-pushed
the
publish-workflow
branch
from
0b496f0
to
bf43fc0
Compare
marcospri
reviewed
Jan 25, 2024
marcospri
approved these changes
Jan 25, 2024
acelaya
force-pushed
the
publish-workflow
branch
from
bf43fc0
to
5e39d25
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #40
Closes #39
Add a new GitHub actions workflow that triggers for every new release, and publishes the plugin to wordpress.org using https://github.com/10up/action-wordpress-plugin-deploy. This seems to be the de-facto GitHub Action to publish WordPress plugins.
Additionally, remove the custom scripts previously used for building and publishing.
TODO