couzteau / SpellCheck

A spell checker for Adobe Brackets
30 stars 11 forks source link

Brackets.io Update: Please merge this pull request. #26

Open brackets-io opened 1 year ago

brackets-io commented 1 year ago

Greetings from the Brackets.io & phcode.dev community. We have simplified extension development and publish workflows for you.

This Pull Request

Please merge in this pull request to be able to publish your extension/theme to the extension store directly from this repository. The pull request adds a GitHub action. The action is triggered whenever a GitHub release is created. The action notifies phcode extension services to pick up the newly released extension and publish it to Brackets/Phcode users.

https://registry.brackets.io/ is deprecated as you can directly publish your extension from GitHub.

Publishing to the extension/theme store

TLDR: Create a release in GitHub with an attached extensions.zip file to publish the extension to the extension/theme store.

Follow the below steps:

  1. Clone your extension repo and increment the version field in package.json file before publishing.
  2. Compress the extension folder into a zip file with name extension.zip. NB: It is important to name the file as exactly extension.zip image
  3. Create a new release in GitHub and attach the above extension.zip file to the release.
    1. On GitHub.com, navigate to the main page of the repository.
    2. To the right of the list of files, click Releases. image
    3. Click on Draft New Release image
    4. Select choose a tag, type in your new extension version and click Create new tag. The tag name can be anything, but we recommend using the version number for clarity. image
    5. Fill out the remaining fields.
    6. Drag and drop the extension.zip file to the release. new extension
    7. Click on Publish release button.

      See Release Example: https://github.com/phcode-dev/extension-template/releases/tag/0.0.1

  4. You will get an issue in your issue tab regarding the publishing status of the extension/theme in a few minutes.

    See Example: https://github.com/phcode-dev/extension-template/issues/2

  5. If there are any errors in publishing, please visit the link in the issue to see the errors. Fix and retry publishing the release. image
  6. Once the extension is published, you should be able to see it in the extension store in https://phcode.dev image

Please note that the extension will currently only be published to phcode.dev.

To publish to the brackets extension store, please raise an issue after publishing the extension to phcode.dev. This is a temporary solution till we have new native builds(read below).

Please see this link for more documentation.

Creating new Extensions and Themes

Click on one of the below links and follow the instructions there to create new themes and extensions:

A Note on the future of Brackets/Phcode.dev

We are working hard to modernize Brackets. New Windows/Linux/Mac native builds are in the works based on the web-first architecture of phcode.dev. Stay tuned for updates in the coming months:

  1. Twitter: phcode.dev , Brackets
  2. YouTube
  3. GitHub: phcode.dev , Brackets