Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ghcup: update metadata version to 0.0.9 #271

Merged
merged 18 commits into from
Jan 4, 2025
Merged

Conversation

Erchiusx
Copy link
Contributor

@Erchiusx Erchiusx commented Jan 3, 2025

ADVISE WANTED

The ghcup team seems to be releasing patches for versions very frequently. As a result, the documentation often requires updates to reflect these changes. However, these updates and commits often feel redundant and contribute to polluting the commit history.

There seem to be two potential solutions to address this issue:

  1. Provide a latest version for each metadata channel:
    This would involve creating the following files that always point to the latest version of the respective metadata:

    • ghcup-latest.yaml
    • ghcup-cross-latest.yaml
    • ghcup-vanilla-latest.yaml
    • ghcup-prereleases-latest.yaml
  2. Make the site more dynamic:
    One option is to embed a JavaScript snippet that dynamically generates the latest version in the documentation. Alternatively, the site could be built daily, retrieving the latest version during the build process. While this could be generalized for other documents, it might be harder to maintain in the long term.

Additionally, these solutions are within our control. Beyond this, we could also consider reaching out to upstream to request that they provide the latest metadata directly to us, as a mirror site, so that we don't need to manage this manually.

@taoky
Copy link
Member

taoky commented Jan 3, 2025

1. **Provide a `latest` version for each metadata channel**:
   This would involve creating the following files that always point to the latest version of the respective metadata:
   
   * `ghcup-latest.yaml`
   * `ghcup-cross-latest.yaml`
   * `ghcup-vanilla-latest.yaml`
   * `ghcup-prereleases-latest.yaml`

I would prefer this: create a symlink to the latest one in the ghcup sync script.

Erchiusx added a commit to Erchiusx/ustcmirror-images that referenced this pull request Jan 3, 2025
docs/ghcup.md Outdated Show resolved Hide resolved
@taoky taoky merged commit dcb82fb into ustclug:master Jan 4, 2025
1 check passed
github-actions bot pushed a commit that referenced this pull request Jan 4, 2025
Erchiusx: [dcb82fb] ghcup: update metadata version to 0.0.9 (#271)

* ghcup: 发布了0.0.9版本的metadata

* ghcup: fit the `latest` style of metadata

* Apply suggestions from code review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants