WordPress.org
Get WordPress

Plugin Directory

Changeset 3247156


Ignore:
Timestamp:
02/26/2025 01:57:06 PM (13 months ago)
Author:
usielriedl
Message:

Add readme.txt content

Location:
sparkling-appcast
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • sparkling-appcast/tags/0.6/README.md

    r3245140 r3247156  
    11# Sparkling Appcast
    22
    3 Sparkling Appcast is a WordPress plugin. It allows you to use your WordPress site to distribute your macOS App via
     3https://wordpress.org/plugins/sparkling-appcast/
     4
     5Sparkling Appcast is a [WordPress plugin](https://wordpress.org/plugins/sparkling-appcast/). It allows you to use your WordPress site to distribute your macOS App via
    46[Sparkle](https://sparkle-project.org/). Sparkling Appcast supports multiple tracks (alpha, beta, ...).
    57

  • sparkling-appcast/tags/0.6/readme.txt

    r3245140 r3247156  
    77License: GPLv2 or later
    88Sparkling Appcast allows you to use your WordPress site to distribute your macOS App via Sparkle offering an appcast.xml endpoint.
     9
     10== Description ==
     11
     12Sparkling Appcast is a WordPress plugin. It allows you to use your WordPress site to distribute your macOS App via
     13[Sparkle](https://sparkle-project.org/). Sparkling Appcast supports multiple tracks (alpha, beta, ...).
     14
     15Sparkling Appcast exposes a new shortcode to display a list of app builds.
     16
     17```
     18[sappcast_display_builds sappcast_track="{track-id-or-slug}"]
     19```
     20
     21Configure Sparkle to ingest the appcast.xml at https://your.site/wp-json/sparkling-appcast/v1/track/{track-id-or-slug}/appcast.xml.
     22You will see something like the following XML.
     23
     24```xml
     25<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" xmlns:dc="http://purl.org/dc/elements/1.1/" version="2.0">
     26    <channel>
     27        <title>MyApp - Production</title>
     28        <link>/wp-json/sparkling-appcast/v1/track/production/appcast.xml</link>
     29        <item>
     30            <title>Version 1.0.1 (2)</title>
     31            <description><![CDATA[ This version is better! ]]></description>
     32            <sparkle:version>2</sparkle:version>
     33            <sparkle:shortVersionString>1.0.1</sparkle:shortVersionString>
     34            <pubDate>Wed, 08 Jan 2025 08:56:19 +0000</pubDate>
     35            <sparkle:minimumSystemVersion>14.0</sparkle:minimumSystemVersion>
     36            <enclosure url="http://localhost:8088/wp-content/uploads/2025/01/app_v2.zip" length="4713394" type="application/octet-stream"/>
     37        </item>
     38        <item>
     39            <title>Version 1.0.0 (1)</title>
     40            <description><![CDATA[ - New features - New bugs ]]></description>
     41            <sparkle:version>1</sparkle:version>
     42            <sparkle:shortVersionString>1.0.0</sparkle:shortVersionString>
     43            <pubDate>Wed, 08 Jan 2025 07:43:06 +0000</pubDate>
     44            <sparkle:minimumSystemVersion>14.0</sparkle:minimumSystemVersion>
     45            <enclosure url="http://localhost:8088/wp-content/uploads/2025/01/app_v1.zip" length="4713394" type="application/octet-stream"/>
     46        </item>
     47    </channel>
     48</rss>
     49```
     50
     51## Configuration
     52
     53To get started name the application you want to distribute on your WordPress site. You can find the settings page under the App Builds menu.
     54
     55![image](https://github.com/user-attachments/assets/ff54e6b7-9bbc-47bf-b7fa-207d627ed548)
     56
     57If you have multiple tracks besides Production, you can should add them on wp-admin under the App Builds menu.
     58
     59![image](https://github.com/user-attachments/assets/92b3c0f5-a993-4b5e-af62-2aae132a978e)
     60
     61## Usage
     62
     63### Fastlane
     64
     65We recommend you use the [`wp_sparkling_appcast` plugin](https://github.com/Usiel/fastlane-plugin-wp_sparkling_appcast) to upload assets and create builds.
     66
     67### Other
     68
     69To distribute a new build, you must upload the asset (1), create a build draft (2), after which you can finalize the
     70build and publish it (3). Steps 1 and 2 are typically executed by your build server, while step 3 is done by a human.
     71
     72### 1. Uploading Asset
     73
     74```bash
     75curl --location "localhost:8088/wp-json/wp/v2/media?status=publish&title=MyApp%20${VERSION}%20(${BUILD_NUMBER})" \
     76    --header "Content-Disposition: attachment; filename=\"myapp_v${VERSION}_${BUILD_NUMBER}.zip\"" \
     77    --header 'Content-Type: application/zip' \
     78    --user "${USER}:${APPLICATION_PASSWORD}" \
     79    --data-binary '@/path/to/asset.zip'
     80```
     81
     82### 2. Create Build Draft
     83
     84```bash
     85curl --location 'localhost:8088/wp-json/wp/v2/sappcast_app_build' \
     86    --header 'Content-Type: application/json' \
     87    --user "${USER}:${APPLICATION_PASSWORD}" \
     88    --data '{
     89        "meta": {
     90            "sappcast_app_build_version": string,
     91            "sappcast_app_build_number": int,
     92            "sappcast_app_build_min_system_version": string,
     93            "sappcast_app_build_attachment_id": int,
     94            "sappcast_app_build_changelog": string,
     95        },
     96        "sappcast_track": int,
     97        "status": "draft"
     98    }'
     99```
     100
     101### 3. Publish Build
     102
     103The user may now go to "App Build" on wp-admin and publish the draft after verifying the build. After publishing the
     104build will appear on the relevant appcast (`/wp-json/sparkling-appcast/v1/track/<track-id-or-slug>/appcast.xml`).

  • sparkling-appcast/trunk/README.md

    r3245140 r3247156  
    11# Sparkling Appcast
    22
    3 Sparkling Appcast is a WordPress plugin. It allows you to use your WordPress site to distribute your macOS App via
     3https://wordpress.org/plugins/sparkling-appcast/
     4
     5Sparkling Appcast is a [WordPress plugin](https://wordpress.org/plugins/sparkling-appcast/). It allows you to use your WordPress site to distribute your macOS App via
    46[Sparkle](https://sparkle-project.org/). Sparkling Appcast supports multiple tracks (alpha, beta, ...).
    57

  • sparkling-appcast/trunk/readme.txt

    r3245140 r3247156  
    77License: GPLv2 or later
    88Sparkling Appcast allows you to use your WordPress site to distribute your macOS App via Sparkle offering an appcast.xml endpoint.
     9
     10== Description ==
     11
     12Sparkling Appcast is a WordPress plugin. It allows you to use your WordPress site to distribute your macOS App via
     13[Sparkle](https://sparkle-project.org/). Sparkling Appcast supports multiple tracks (alpha, beta, ...).
     14
     15Sparkling Appcast exposes a new shortcode to display a list of app builds.
     16
     17```
     18[sappcast_display_builds sappcast_track="{track-id-or-slug}"]
     19```
     20
     21Configure Sparkle to ingest the appcast.xml at https://your.site/wp-json/sparkling-appcast/v1/track/{track-id-or-slug}/appcast.xml.
     22You will see something like the following XML.
     23
     24```xml
     25<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" xmlns:dc="http://purl.org/dc/elements/1.1/" version="2.0">
     26    <channel>
     27        <title>MyApp - Production</title>
     28        <link>/wp-json/sparkling-appcast/v1/track/production/appcast.xml</link>
     29        <item>
     30            <title>Version 1.0.1 (2)</title>
     31            <description><![CDATA[ This version is better! ]]></description>
     32            <sparkle:version>2</sparkle:version>
     33            <sparkle:shortVersionString>1.0.1</sparkle:shortVersionString>
     34            <pubDate>Wed, 08 Jan 2025 08:56:19 +0000</pubDate>
     35            <sparkle:minimumSystemVersion>14.0</sparkle:minimumSystemVersion>
     36            <enclosure url="http://localhost:8088/wp-content/uploads/2025/01/app_v2.zip" length="4713394" type="application/octet-stream"/>
     37        </item>
     38        <item>
     39            <title>Version 1.0.0 (1)</title>
     40            <description><![CDATA[ - New features - New bugs ]]></description>
     41            <sparkle:version>1</sparkle:version>
     42            <sparkle:shortVersionString>1.0.0</sparkle:shortVersionString>
     43            <pubDate>Wed, 08 Jan 2025 07:43:06 +0000</pubDate>
     44            <sparkle:minimumSystemVersion>14.0</sparkle:minimumSystemVersion>
     45            <enclosure url="http://localhost:8088/wp-content/uploads/2025/01/app_v1.zip" length="4713394" type="application/octet-stream"/>
     46        </item>
     47    </channel>
     48</rss>
     49```
     50
     51## Configuration
     52
     53To get started name the application you want to distribute on your WordPress site. You can find the settings page under the App Builds menu.
     54
     55![image](https://github.com/user-attachments/assets/ff54e6b7-9bbc-47bf-b7fa-207d627ed548)
     56
     57If you have multiple tracks besides Production, you can should add them on wp-admin under the App Builds menu.
     58
     59![image](https://github.com/user-attachments/assets/92b3c0f5-a993-4b5e-af62-2aae132a978e)
     60
     61## Usage
     62
     63### Fastlane
     64
     65We recommend you use the [`wp_sparkling_appcast` plugin](https://github.com/Usiel/fastlane-plugin-wp_sparkling_appcast) to upload assets and create builds.
     66
     67### Other
     68
     69To distribute a new build, you must upload the asset (1), create a build draft (2), after which you can finalize the
     70build and publish it (3). Steps 1 and 2 are typically executed by your build server, while step 3 is done by a human.
     71
     72### 1. Uploading Asset
     73
     74```bash
     75curl --location "localhost:8088/wp-json/wp/v2/media?status=publish&title=MyApp%20${VERSION}%20(${BUILD_NUMBER})" \
     76    --header "Content-Disposition: attachment; filename=\"myapp_v${VERSION}_${BUILD_NUMBER}.zip\"" \
     77    --header 'Content-Type: application/zip' \
     78    --user "${USER}:${APPLICATION_PASSWORD}" \
     79    --data-binary '@/path/to/asset.zip'
     80```
     81
     82### 2. Create Build Draft
     83
     84```bash
     85curl --location 'localhost:8088/wp-json/wp/v2/sappcast_app_build' \
     86    --header 'Content-Type: application/json' \
     87    --user "${USER}:${APPLICATION_PASSWORD}" \
     88    --data '{
     89        "meta": {
     90            "sappcast_app_build_version": string,
     91            "sappcast_app_build_number": int,
     92            "sappcast_app_build_min_system_version": string,
     93            "sappcast_app_build_attachment_id": int,
     94            "sappcast_app_build_changelog": string,
     95        },
     96        "sappcast_track": int,
     97        "status": "draft"
     98    }'
     99```
     100
     101### 3. Publish Build
     102
     103The user may now go to "App Build" on wp-admin and publish the draft after verifying the build. After publishing the
     104build will appear on the relevant appcast (`/wp-json/sparkling-appcast/v1/track/<track-id-or-slug>/appcast.xml`).
Note: See TracChangeset for help on using the changeset viewer.