Skip to content

Publish from GitHub Actions

The StoreFast GitHub Action sends your .msix to StoreFast from a workflow. It writes the release notes from your changelog or GitHub release and translates them into every language of your listing.

Add your API key

  1. 1

    In StoreFast, open Settings and create an API key that Can publish. You see it once, so copy it now.

  2. 2

    In your GitHub repository, open Settings, then Secrets and variables, then Actions, and add a secret named STOREFAST_API_KEY with the key.

Add the step

This workflow runs when you publish a GitHub release. It downloads the .msix attached to the release and sends it to StoreFast. If your workflow builds the package itself, add the last step right after the one that makes it.

Workflow
name: Microsoft Store

on:
  release:
    types: [published]

jobs:
  store:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v4

      - name: Download the MSIX from the release
        env:
          GH_TOKEN: ${{ github.token }}
        run: gh release download "${{ github.event.release.tag_name }}" --pattern '*.msix'

      - uses: legendaryspy/storefast-publish@2e5447f5ea711b19832d8b6449118e6a11b7ad11 # v1.0.1
        with:
          api-key: ${{ secrets.STOREFAST_API_KEY }}
          app: 9PJWF4W8V4WG
          package: '*.msix'
api-key
The secret you added. Required.
app
The app's Store ID (12 characters for an MSIX app, 14 starting with XP for an MSI or EXE app), its StoreFast app ID or its exact name. Required.
package
A path or glob pattern that matches exactly one .msix. Required for an MSIX app.

The version is read from the package. The notes come from the matching section of CHANGELOG.md when there is one, and otherwise from the release's description. Long notes are shortened to fit the Store's 1,500 characters.

MSI and EXE apps

For an MSI or EXE app, upload the new installer to your own host first, at a link with the version in it. Then pass the link instead of package:

Step
      - uses: legendaryspy/storefast-publish@2e5447f5ea711b19832d8b6449118e6a11b7ad11 # v1.0.1
        with:
          api-key: ${{ secrets.STOREFAST_API_KEY }}
          app: XPXXXXXXXXXXXX
          installer-url: https://downloads.example.com/myapp/${{ github.event.release.tag_name }}/MyApp-Setup-x64.exe
          installer-architecture: X64
installer-url
The HTTPS link to the new installer. The file at it must never change.
installer-architecture
X86, X64, Arm, Arm64 or Neutral. Defaults to X64.
installers
For several installers, one architecture and link per line, like Arm64 https://downloads.example.com/1.4.0/setup-arm64.exe.

The version labels the update, since the Store shows none for these apps. On a release event it comes from the tag, and otherwise from the version input.

Review or submit

By default the update waits on your app's page in StoreFast, and nothing goes to Microsoft until you click Submit for review. When you trust the workflow to ship on its own, add these inputs:

  • submit: true submits the update for certification straight away.
  • wait: true also waits until Partner Center has the submission, which usually takes a few minutes. It doesn't wait for certification.

The action's README lists every input, like notes from a file, dropping lines that only concern other platforms, and replacing an unfinished update.

Stuck on something? Email hello@storefast.app and we'll help you get it working.