Archive/opengoal-launcher
1
0
Fork 0
mirror of https://github.com/open-goal/launcher.git synced 2024-10-20 04:57:38 -04:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

docs: document intended release process

Browse source
This commit is contained in:
Tyler Wilding 2022-04-28 20:06:44 -04:00
parent 25f21e046d
commit 036a049cb1
No known key found for this signature in database
GPG key ID: A89403EB356ED106
2 changed files with 31 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
.github/scripts/update-release-metadata/index.js vendored
View file

@ -40,7 +40,7 @@ let tagToSearchFor = process.env.TAG_VALUE.split("refs/tags/")[1];
const { data: releaseData } = await octokit.rest.repos.getReleaseByTag({ const { data: releaseData } = await octokit.rest.repos.getReleaseByTag({
owner: "open-goal", owner: "open-goal",
repo: "jak-project", repo: "jak-project",
tag: tagToSearchFor tag: tagToSearchFor,
}); });
if (releaseData === undefined) { if (releaseData === undefined) {
@ -50,21 +50,24 @@ if (releaseData === undefined) {
// TODO - no macOS yet // TODO - no macOS yet
const releaseMeta = { const releaseMeta = {
"name": releaseData.tag_name, name: releaseData.tag_name,
"notes": "UPDATE", notes: "UPDATE",
"pub_date": releaseData.created_at, pub_date: releaseData.created_at,
"platforms": { platforms: {
"linux": { linux: {
"signature": "", signature: "",
"url": `https://github.com/open-goal/launcher/releases/download/${releaseData.tag_name}/opengoal-launcher-linux.AppImage.tar.gz` url: `https://github.com/open-goal/launcher/releases/download/${releaseData.tag_name}/opengoal-launcher-linux.AppImage.tar.gz`,
}, },
"win64": { win64: {
"signature": "", signature: "",
"url": `https://github.com/open-goal/launcher/releases/download/${releaseData.tag_name}/opengoal-launcher-windows.x64.msi.zip` url: `https://github.com/open-goal/launcher/releases/download/${releaseData.tag_name}/opengoal-launcher-windows.x64.msi.zip`,
} },
} },
} };
fs.writeFileSync("./.tauri/latest-release.json", JSON.stringify(releaseMeta, null, 2)); fs.writeFileSync(
"./.tauri/latest-release.json",
JSON.stringify(releaseMeta, null, 2)
);
// TODO - take the release out of draft when we are ready to actually publish! // TODO - take the release out of draft when we are ready to actually publish!

13
README.md
View file

@ -28,3 +28,16 @@ We are using Tauri to build a native app, but still with simple Web technology.
- `npm run tauri dev` - `npm run tauri dev`
This builds the app with Tauri (this is a rust compilation, the first run will take a while) and the frontend is served via Vite -- a nice web server that will hot-reload any changes as you develop. This builds the app with Tauri (this is a rust compilation, the first run will take a while) and the frontend is served via Vite -- a nice web server that will hot-reload any changes as you develop.
## Release Process
```mermaid
sequenceDiagram
jak-project->>jak-project: New tag is manually cut and built
jak-project->>launcher: Repository Dispatch to start release
launcher->>launcher: Alternatively, manually triggered release here
launcher->>launcher: Build App for all supported platforms
launcher->>launcher: Publish release and update latest release metadata file in repo
website->>GitHub API: Website will display latest release
app->>launcher: Detect new version and will prompt the user to update
```