Skip to content

chore: Setup workflow for plugin BETA releases #257

Closed
Closed
chore: Setup workflow for plugin BETA releases#257
Assignees
colinmurphy
Labels
[Area] PreviewsIssues for the HWP Previews plugin[Area] WebhooksIssues for the WPGraphQL Webhooks plugin

Description

@colinmurphy
colinmurphy
opened on Jun 16, 2025

Overview

When merging into main for a modified plugin (currently webhooks or previews), we should be creating a release for this plugin.

The naming convention should be currently prefixed with "beta-[GITHUB SHA]" so users can identify the release as BETA.

Activity

  1. colinmurphy
    self-assigned this
    on Jun 16, 2025
  2. github-project-automation
    added this to Headless OSSon Jun 16, 2025
  3. github-project-automation
    moved this to 🆕 Backlog in Headless OSSon Jun 16, 2025
  4. colinmurphy
    added
    [Area] PreviewsIssues for the HWP Previews plugin
    [Area] WebhooksIssues for the WPGraphQL Webhooks plugin
    on Jun 16, 2025
  5. colinmurphy
    added a parent issue on Jun 16, 2025
  6. colinmurphy
    added a commit that references this issue on Jun 18, 2025

    Set plugin version as 0.0.1-beta for #257 process

    bf2ead5
  7. colinmurphy
    moved this from 🆕 Backlog to 🔖 Ready for Development in Headless OSSon Jun 24, 2025
  8. colinmurphy
    moved this from 🔖 Ready for Development to 🏗 In progress in Headless OSSon Jun 24, 2025

  9. colinmurphy commented on Jun 24, 2025

    @colinmurphy
    colinmurphy
    on Jun 24, 2025
    MemberAuthor

    Workflow for Releasing a Plugin

    Pre-requisites

    1. Setup changeset bot in the repository like we have on Faust and Content Blocks
    2. Any plugin that wants to use this should have a package.json (thanks Joe) and a CHANGELOG.md file.

    High level workflow

    1. PR creation for a plugin

    1. A PR is created with changes to the plugin
    2. Changeset bot checks for changeset for a plugin (can be configured. See Faust.js https://github.com/wpengine/faustjs/blob/canary/.changeset/config.json)
    3. A changeset is added.
    4. The plugin follows our normal PR review process (defined in https://github.com/wpengine/hwptoolkit/blob/main/HOW_WE_WORK.md)
    5. And then the PR is merged into the main branch.

    2. Changeset bot workflow

    1. This should then create a PR for the changeset (e.g. on Faust - Version Packages faustjs#2112)

    2. This should contain the following:

      • Release notes for the plugin and updated the CHANGELOG.md file
      • Deleted the changeset file
      • Updated the version for the plugin

    3. Once merged it should then trigger the release workflow

    3. Release workflow

    See Faust.js as an example -https://github.com/wpengine/faustjs/blob/canary/.github/workflows/release-packages.yml

    1. Check if there was a changeset to the plugin
    2. If so then run the release workflow action:
      • Creates a zip using composer archive
      • Uploads this as part of a GH release
      • The release should be called "hwp-previews-vX.Y.Z" where X.Y.Z is the version of the plugin

  10. colinmurphy commented on Jun 24, 2025

    @colinmurphy
    colinmurphy
    on Jun 24, 2025
    MemberAuthor

    PR for changsets to add the changset bot - #272

  11. colinmurphy
    moved this from 🏗 In progress to 👀 In review in Headless OSSon Jun 25, 2025

  12. colinmurphy commented on Jun 26, 2025

    @colinmurphy
    colinmurphy
    on Jun 26, 2025
    MemberAuthor

    Closing as this is now setup.

    https://github.com/wpengine/hwptoolkit/releases/tag/%40wpengine%2Fhwp-previews-wordpress-plugin-0.0.2

  13. colinmurphy
    closed this as completedon Jun 26, 2025
  14. github-project-automation
    moved this from 👀 In review to ✅ Closed in Headless OSSon Jun 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

[Area] PreviewsIssues for the HWP Previews plugin[Area] WebhooksIssues for the WPGraphQL Webhooks plugin

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions