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

Guide users to checkout curent release for source builds #264

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

AnthonyZhOon
Copy link

@AnthonyZhOon AnthonyZhOon commented Jan 6, 2025

Currently the Building From Source docs direct users to build ghostty from the main branch, this results in users experiencing inconsistency with the docs and codebase. I think it's more reasonable to mention the current release, so the docs can be stable. Maybe versioned docs can be provided for each release + tip in the future like https://wiki.hyprland.org/version-selector/.

Copy link

vercel bot commented Jan 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 7, 2025 1:33am

@AnthonyZhOon
Copy link
Author

This is conflicts with #263 which goes with keeping docs in sync in the tip build of ghostty.

Copy link
Contributor

@mitchellh mitchellh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments


```sh
git clone https://github.com/ghostty-org/ghostty
cd ghostty
git checkout v1.0.1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The major issue I have with this PR is I don't want to keep this up to date. We either need to generalize this or just write some English that informs people to look at tags.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we only create tags for releases then
git describe --tags --abbrev=0 gives the closest tag to the current commit.
as in git checkout $(git describe --tags --abbrev=0) but it's a slightly dependent on the shell they use.
To guide them to manually pick a tag we can use git tag --list to display the available tags and with semver it should be simple to pick the latest one. We can take it further with git tag --list --sort=-version:refname 'v*' to order and only show releases but that might be too much.
I'll write a change for the second one for now, though it might put users into a pager.

@BrandonRomano BrandonRomano added the docs Related to documentation label Jan 7, 2025
BrandonRomano and others added 4 commits January 7, 2025 12:21
This was causing the share cards to be quite large on discord as well,
which is taking up a lot of space. Going to optimize against discord for
now.
Package `wayland-protocols-devel` needs to be installed for the latest code to build, otherwise FTBFS.

Running the following fixes the build:

```
dnf install wayland-protocols-devel.noarch
```

NOTE: I haven't tested the Fedora Atomic package names.
- Use 'Pretendard Standard' to only use latin subset, reduce font file size from 2mb to 292kb.
- Change variable name `pretendardVariable` to `pretendardStandardVariable`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants