Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/godbout/AlfredWorkflowUpdater
add a background updater for your Alfred Workflow in under a minute ⏲️
https://github.com/godbout/AlfredWorkflowUpdater
alfred love swift update updater workflow
Last synced: about 1 month ago
JSON representation
add a background updater for your Alfred Workflow in under a minute ⏲️
- Host: GitHub
- URL: https://github.com/godbout/AlfredWorkflowUpdater
- Owner: godbout
- License: mit
- Created: 2021-03-30T04:52:25.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-16T06:18:10.000Z (about 1 year ago)
- Last Synced: 2024-05-21T12:32:34.442Z (4 months ago)
- Topics: alfred, love, swift, update, updater, workflow
- Language: Swift
- Homepage:
- Size: 78.1 KB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
Alfred Workflow Updater
___
# What is that
It's a Command Line Tool that you embed in your Workflow. That is it.
Then you call it from your Workflow and it does some magic.
# Why
Who wants to go check GitHub or a forum post manually to update your Workflow hmm?
# Features
* checks for updates on GitHub in the background
* only checks when necessary (frequency checks)
* opens your GitHub release page if you want
* downloads your latest release, moves it to the Users' download folder, opens the workflow
* notifications of your download come from your Workflow, so it's non-blocking and uses your icon ✌🏼️
# OK, how does it work in real
Alfred Workflow Updater writes a file called `last_checked.plist` in your Workflow cache folder that holds information about the last online check.
When the threshold you specified as a argument (see [API](https://github.com/godbout/AlfredWorkflowUpdater#in-your-workflow-script)) is passed, Alfred Workflow Updater checks online if there's an update available for your Workflow, comparing your current local Workflow version against the online latest version available on GitHub.
If a an update is found, Alfred Workflow Updater drops an `update_available.plist` file in your Workflow cache folder. This file contains your latest release info (version, file URL, page URL).
All you have to do is pick up that file and show the update whenever and however you want in your own Alfred Workflow.
# Hmm, any screenshot?
Better, a video:
https://user-images.githubusercontent.com/121373/180831445-2a6f61bc-4cd9-4277-9f68-8ce08fe83e04.mp4
# API
## in your Workflow Script
1. Call the Alfred Workflow Updater tool with 2 parameters:
* your GitHub repo, like: "[godbout/WooshyWindowToTheForeground](https://github.com/godbout/WooshyWindowToTheForeground)"
* the frequency threshold in minutes, like "60"
2. Add an [`Environment Variable`](https://www.alfredapp.com/help/workflows/advanced/variables/#environment) called `alfred_workflow_updater_asset_name` that contains the name of your Alfred Workflow file as shown in the GitHub Releases. This is necessary because GitHub now loads assets dynamically and we can't grab the asset name through HTML scrapping.
## in your Alfred Results
You can:
1. generate an update of your Workflow by adding an [item variable](https://www.alfredapp.com/help/workflows/inputs/script-filter/json/#variables) to your Alfred Result with the name `AlfredWorkflowUpdater_action` and the value `update`
2. open your Workflow's GitHub release page by adding an [item variable](https://www.alfredapp.com/help/workflows/inputs/script-filter/json/#variables) to your Alfred Result with the name `AlfredWorkflowUpdater_action` and the value `open`
You do not need to pass any other variables with those Alfred Results. The Alfred Workflow Updater will grab the necessary info from your Workflow's cache folder instead.
# Any concrete example?
The following Workflows are using the Alfred Workflow Updater. Best is to download one of them, open it, and check how it's made (it's simple):
* [Alfred Kat](https://github.com/godbout/AlfredKat)
* [Wooshy: Window to the Foreground!](https://github.com/godbout/WooshyWindowToTheForeground)