https://github.com/raycast/extensions-template

Template repository for automatic extensions publishing
https://github.com/raycast/extensions-template

Last synced: about 5 hours ago
JSON representation

Template repository for automatic extensions publishing

• Host: GitHub
• URL: https://github.com/raycast/extensions-template
• Owner: raycast
• License: mit
• Created: 2022-07-06T10:44:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-25T06:31:21.000Z (about 2 years ago)
• Last Synced: 2024-11-17T09:41:16.583Z (2 months ago)
• Size: 3.91 KB
• Stars: 16
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Template to store extensions for your private Store in Raycast

Automatically build & publish extensions to your private store in [Raycast](https://www.raycast.com/)

## :hammer_and_wrench: Features

- Easily build & publish your extensions to private store

- Collaborate on extensions through Pull Requests with automatic validation

## :robot: How to use ?

1. Click the [Use this template](https://github.com/raycast/extensions-template/generate) button and generate a repository from this template.

3. [Add a secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to generated repository named `RAYCAST_ORGANIZATION_TOKEN` with value being your [personal token](https://developers.raycast.com/teams-beta/publish-a-private-extension). You can read the `RAYCAST_ORGANIZATION_TOKEN` by running `ray token` on your local machine (or use the -C option to copy it to the clipboard automatically).

4. Checkout new repository and create your extension in `extensions` subfolder (example: `extensions/hello-world/package.json`).

5. Push your extension to the `main` branch and watch as the GitHub actions pick it up and publish it to your private store.

    Alternatively, push your extension to a different branch and create a Pull Requests for it that will validate it through automatic [status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). To publish it simply merge a Pull Request to the `main` branch.

## :page_with_curl: Documentation & Resources

- See [Raycast](https://www.raycast.com/) for downloading Raycast

- See [developers.raycast.com](https://developers.raycast.com/) for guides, examples, references, and more to help you build extensions.

- See [Getting Started](https://developers.raycast.com/teams-beta/getting-started) for Raycast for Teams