[PR #6] [MERGED] Add a description to the readme #12

New Issue

giteasync · 2025-09-10T23:56:36-05:00

giteasync commented

2025-09-10 23:56:36 -05:00

📋 Pull Request Information

Original PR: https://github.com/VSCodium/update-api/pull/6
Author: @TyMick
Created: 10/12/2020
Status: ✅ Merged
Merged: 10/12/2020
Merged by: @stripedpajamas

Base: master ← Head: add-context-to-readme

📝 Commits (1)

8ee2aab Add a description to the readme

📊 Changes

1 file changed (+3 additions, -1 deletions)

View changed files

📝 README.md (+3 -1)

📄 Description

Just felt like adding a little context to the readme in case anyone lands on this repo not knowing what it is (and so they don't have to read through a project and/or an issue comment thread to figure it out).

New readme:

update-api

A small server that VSCodium calls to check for the latest release on GitHub. See the Auto Update Support project and the original issue for more context.

Note: Even though the description for the update.mode setting in VSCodium says "The updates are fetched from a Microsoft online service", the build script sets the updateUrl field in product.json to https://vscodium.now.sh, so Microsoft's update service isn't actually called.

Description comes from this @‌stripedpajamas comment, and I added the additional note because it was something I was confused about until I found that line in prepare_vscode.sh.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/VSCodium/update-api/pull/6 **Author:** [@TyMick](https://github.com/TyMick) **Created:** 10/12/2020 **Status:** ✅ Merged **Merged:** 10/12/2020 **Merged by:** [@stripedpajamas](https://github.com/stripedpajamas) **Base:** `master` ← **Head:** `add-context-to-readme` --- ### 📝 Commits (1) - [`8ee2aab`](https://github.com/VSCodium/update-api/commit/8ee2aab0530f07f539617ec79a41aa65752a8519) Add a description to the readme ### 📊 Changes **1 file changed** (+3 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+3 -1) </details> ### 📄 Description Just felt like adding a little context to the readme in case anyone lands on this repo not knowing what it is (and so they don't have to read through a project and/or an issue comment thread to figure it out). New readme: > # update-api > > A small server that VSCodium calls to check for the latest release on GitHub. See the [Auto Update Support project](https://github.com/VSCodium/vscodium/projects/1) and the [original issue](https://github.com/VSCodium/vscodium/issues/41) for more context. > > **Note:** Even though the description for the `update.mode` setting in VSCodium says "The updates are fetched from a Microsoft online service", the build script [sets the `updateUrl` field](https://github.com/VSCodium/vscodium/blob/master/prepare_vscode.sh#L36) in `product.json` to https://vscodium.now.sh, so Microsoft's update service isn't actually called. Description comes from [this **@&zwnj;stripedpajamas** comment](https://github.com/VSCodium/vscodium/issues/411#issuecomment-640241736), and I added the additional note because it was something I was confused about until I found that line in `prepare_vscode.sh`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

giteasync added the

pull-request

label 2025-09-10 23:56:36 -05:00

giteasync closed this issue

2025-09-10 23:56:36 -05:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: VSCodium/update-api#12