Skip to content

Commit

Permalink
Prepare for packagist.org publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
acelaya committed Jan 26, 2024
1 parent 266d456 commit dbfc545
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 2 deletions.
1 change: 1 addition & 0 deletions .distignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.distignore
.editorconfig
.git
.gitattributes
.github
.gitignore
composer.json
Expand Down
8 changes: 8 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.distignore export-ignore
.github export-ignore
.gitattributes export-ignore
.gitignore export-ignore
composer.lock export-ignore
docker-compose.yml export-ignore
package-lock.lock export-ignore
phpcs.xml export-ignore
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@

Stable versions are available on the [Hypothesis plugin page on WordPress.org](https://wordpress.org/plugins/hypothesis/).

## Install Directions
## Install this plugin

### Via composer

This plugin can be installed with composer, from the standard package registry (packagist.org)

composer require hypothesis/hypothesis-wp-plugin

### Via WordPress plugins directory

1. Visit your WordPress plugins page (/wp-admin/plugins.php)
2. Click the Add New button
Expand All @@ -20,6 +28,9 @@ Follow these steps to publish a new plugin version.
3. **Merge** the changes into the `main` branch[^1]. We use [Semantic Versioning](https://semver.org/#semantic-versioning-200).
4. **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

> [!NOTE]
> The package will be automatically published in packagist.org just by pushing the new git tag.
### Creating a GitHub release

Create a [new GitHub release](https://github.com/hypothesis/wp-hypothesis/releases/new/) with these values:
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "hypothesis/hypothesis",
"name": "hypothesis/hypothesis-wp-plugin",
"description": "An open platform for the collaborative evaluation of knowledge.",
"homepage": "https://github.com/hypothesis/wp-hypothesis",
"support": {
Expand Down

0 comments on commit dbfc545

Please sign in to comment.