1 00ced238 2021-09-24 thomas README.portable
2 00ced238 2021-09-24 thomas ===============
4 00ced238 2021-09-24 thomas **NOTE: This repository is read-only and is used only to mirror the
5 00ced238 2021-09-24 thomas got-portable repository for CI purposes.**
7 00ced238 2021-09-24 thomas This is the portable version of got[1] (Game of Trees), using autotools to
8 e499844e 2022-03-03 thomas provide the library checks required for GoT's dependencies.
10 e499844e 2022-03-03 thomas The following operating systems are supported:
14 b26177ad 2022-03-03 thomas * DragonFlyBSD
18 00ced238 2021-09-24 thomas DEPENDENCIES
19 00ced238 2021-09-24 thomas ============
21 62e037f1 2024-04-26 thomas.ad Note that the names of these libraries are indicative only; the names might
26 00ced238 2021-09-24 thomas * `libncurses` (for tog(1))
27 bd1cad3c 2022-04-30 thomas * `libbsd` (BSD's arc4random routines)
28 5007bd0d 2023-04-14 thomas * `libmd` (SHA256 routines)
29 00ced238 2021-09-24 thomas * `libuuid` (for UUID generation)
30 00ced238 2021-09-24 thomas * `libz` (for Z compression)
31 00ced238 2021-09-24 thomas * `pkg-config` (for searching libraries)
32 ebc794c1 2021-10-20 thomas * `bison` (for configuration file grammar)
33 62e037f1 2024-04-26 thomas.ad * `libtls` (may be known as `libretls`)
37 e499844e 2022-03-03 thomas * `automake`
38 e499844e 2022-03-03 thomas * `pkgconf`
39 20a7eac5 2023-03-03 thomas * `libevent` (for gotwebd)
40 62e037f1 2024-04-26 thomas.ad * `libretls`
44 e499844e 2022-03-03 thomas * `automake`
45 e499844e 2022-03-03 thomas * `libuuid`
46 e499844e 2022-03-03 thomas * `ncuresesw`
47 20a7eac5 2023-03-03 thomas * `libevent` (for gotwebd)
48 62e037f1 2024-04-26 thomas.ad * `libretls`
50 b26177ad 2022-03-03 thomas DragonFlyBSD:
52 b26177ad 2022-03-03 thomas * `automake`
53 b26177ad 2022-03-03 thomas * `pkgconf`
54 b26177ad 2022-03-03 thomas * `openssl`
55 20a7eac5 2023-03-03 thomas * `libevent` (for gotwebd)
56 62e037f1 2024-04-26 thomas.ad * `libretls`
58 e499844e 2022-03-03 thomas Darwin (MacOS):
60 e499844e 2022-03-03 thomas * `automake`
62 e499844e 2022-03-03 thomas * `pkg-config`
63 e499844e 2022-03-03 thomas * `ncurses`
64 e499844e 2022-03-03 thomas * `openssl`
65 e499844e 2022-03-03 thomas * `ossp-uuid`
66 20a7eac5 2023-03-03 thomas * `libevent` (for gotwebd)
67 62e037f1 2024-04-26 thomas.ad * `libtls`
69 00ced238 2021-09-24 thomas TESTS (REGRESS)
70 00ced238 2021-09-24 thomas ===============
72 00ced238 2021-09-24 thomas To run the test suite:
75 00ced238 2021-09-24 thomas $ make tests
78 5713faaf 2023-03-09 thomas Dependencies
79 5713faaf 2023-03-09 thomas ============
83 00ced238 2021-09-24 thomas NOTE: THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
84 00ced238 2021-09-24 thomas HELPERS ARE HARD-CODED INTO THE BINARIES.
86 00ced238 2021-09-24 thomas INSTALLATION
87 00ced238 2021-09-24 thomas ============
90 00ced238 2021-09-24 thomas $ ./autogen.sh
91 00ced238 2021-09-24 thomas $ ./configure && make
92 00ced238 2021-09-24 thomas $ sudo make install
95 0edd41e7 2023-08-29 thomas INSTALLING AND PACKAGING GITWRAPPER
96 0edd41e7 2023-08-29 thomas ===================================
98 0edd41e7 2023-08-29 thomas The gotd server has an optional companion tool called gitwrapper.
100 0edd41e7 2023-08-29 thomas A gotd server can be used without gitwrapper in the following cases:
102 0edd41e7 2023-08-29 thomas 1) The Git client's user account has gotsh configured as its login shell.
104 0edd41e7 2023-08-29 thomas 2) The Git client's user account sees gotsh installed under the names
105 0edd41e7 2023-08-29 thomas git-receive-pack and git-upload-pack, and these appear in $PATH before
106 0edd41e7 2023-08-29 thomas the corresponding Git binaries if Git is also installed. Setting up the
107 0edd41e7 2023-08-29 thomas user's $PATH in this way can require the use of SetEnv in sshd_config.
109 0edd41e7 2023-08-29 thomas The above cases can be too restrictive. For example, users who have regular
110 0edd41e7 2023-08-29 thomas shell access to the system may expect to be able to serve Git repositories
111 0edd41e7 2023-08-29 thomas from their home directories while also accessing repositories served by gotd.
113 0edd41e7 2023-08-29 thomas Once gitwrapper has been installed correctly it provides an out-of-the box
114 0edd41e7 2023-08-29 thomas experience where both gotd and Git "just work".
115 0edd41e7 2023-08-29 thomas However, this will require coordination with the system's Git installation
116 0edd41e7 2023-08-29 thomas and/or distribution package because the names of two specific Git programs
117 0edd41e7 2023-08-29 thomas will be overlapping: git-upload-pack and git-receive-pack
119 0edd41e7 2023-08-29 thomas If the gitwrapper tool will be used then it must replace git-receive-pack
120 0edd41e7 2023-08-29 thomas and git-upload-pack in /usr/bin. This is usually achieved by replacing the
121 0edd41e7 2023-08-29 thomas regular Git binaries in /usr/bin with symlinks to gitwrapper:
124 0edd41e7 2023-08-29 thomas -rwxr-xr-x 1 root root 1019928 Aug 24 00:16 /usr/bin/gitwrapper
125 0edd41e7 2023-08-29 thomas lrwxrwxrwx 1 root root 10 Aug 20 12:40 /usr/bin/git-receive-pack -> gitwrapper
126 0edd41e7 2023-08-29 thomas lrwxrwxrwx 1 root root 10 Aug 20 12:40 /usr/bin/git-upload-pack -> gitwrapper
129 0edd41e7 2023-08-29 thomas The Git binaries remain available in Git's libexec directory, which is set
130 0edd41e7 2023-08-29 thomas when Git gets compiled. On Debian it defaults to /usr/lib/git-core.
131 0edd41e7 2023-08-29 thomas This same path must be given to Got's configure script at build time to
132 0edd41e7 2023-08-29 thomas allow gitwrapper to find Git's binaries:
135 0edd41e7 2023-08-29 thomas ./configure --with-gitwrapper-git-libexec-path=/usr/lib/git-core
138 0edd41e7 2023-08-29 thomas Once gitwrapper is found in /usr/bin under the names git-receive-pack and
139 0edd41e7 2023-08-29 thomas git-upload-pack, any Git repositories listed in /etc/gotd.conf will be
140 0edd41e7 2023-08-29 thomas automatically served by gotd, and any Git repositories not listed in
141 0edd41e7 2023-08-29 thomas /etc/gotd.conf will be automatically served by regular Git's git-upload-pack
142 0edd41e7 2023-08-29 thomas and git-receive-pack. The client's login shell or $PATH no longer matter,
143 0edd41e7 2023-08-29 thomas and a peaceful co-existence of gotd and Git is possible.
145 0edd41e7 2023-08-29 thomas We recommend that distribution packagers take appropriate steps to package
146 0edd41e7 2023-08-29 thomas gitwrapper as a required dependency of gotd. It is also possible to install
147 0edd41e7 2023-08-29 thomas gitwrapper without installing gotd. As long as /etc/gotd.conf does not exist
148 0edd41e7 2023-08-29 thomas or no repositories are listed in /etc/gotd.conf there will be no visible
149 0edd41e7 2023-08-29 thomas change in run-time behaviour for Git users since gitwrapper will simply run
150 0edd41e7 2023-08-29 thomas the standard Git tools.
151 0edd41e7 2023-08-29 thomas In the OpenBSD ports tree both the regular git package and the gotd package
152 0edd41e7 2023-08-29 thomas are depending on gitwrapper, and the git package no longer installs the
153 0edd41e7 2023-08-29 thomas git-receive-pack and git-upload-pack programs in /usr/local/bin.
155 00ced238 2021-09-24 thomas BRANCHES + SUBMITTING PATCHES
156 00ced238 2021-09-24 thomas =============================
158 00ced238 2021-09-24 thomas `got-portable` has two key branches:
160 00ced238 2021-09-24 thomas * `main` which tracks got upstream untainted.
161 04dafe6d 2023-03-10 thomas * `portable` which provides the portable version of GoT based from code on `main`
163 04dafe6d 2023-03-10 thomas Patches for portable code fixes should be based from the `portable` branch and
164 00ced238 2021-09-24 thomas sent to the mailing list for review [2] or sent to me directly (see CONTACT).
166 61702ba6 2022-07-19 thomas Portable-specific patches should have a shortlog in the form of:
169 61702ba6 2022-07-19 thomas portable: AREA: description
172 61702ba6 2022-07-19 thomas Where `AREA` relates to the change in question (for example, `regress`,
173 61702ba6 2022-07-19 thomas `libexec`, etc). In some cases, this can be omitted if it's a generic change.
175 61702ba6 2022-07-19 thomas This helps to delineate `-portable` changes from upstream `got`.
177 00ced238 2021-09-24 thomas The read-only Github repository also runs CI checks using Cirrus-CI on Linux
178 00ced238 2021-09-24 thomas and FreeBSD.
180 585fb430 2022-07-21 thomas SYNCING UPSTREAM CHANGES WITH PORTABLE
181 585fb430 2022-07-21 thomas ======================================
183 585fb430 2022-07-21 thomas The `-portable` GoT repository uses the following workflow:
186 585fb430 2022-07-21 thomas Github (gh) GoT (upstream)
192 585fb430 2022-07-21 thomas +--------> GoT-portable <------+
196 585fb430 2022-07-21 thomas Here, `got-portable` is a clone of the `-portable` repository, locally on
197 585fb430 2022-07-21 thomas disk. There are two remotes set up within that repository, via `git-remote`:
199 585fb430 2022-07-21 thomas * `upstream` -- which points to the official GoT repository;
200 585fb430 2022-07-21 thomas * `gh` -- which points to the mirrored `-portable` repository so that CI can
201 585fb430 2022-07-21 thomas be run for cross-platform/test purposes [3]
202 585fb430 2022-07-21 thomas * `origin` -- our cloned copy from `-portable`
204 585fb430 2022-07-21 thomas Within the `-portable` repository are two key branches (there may be other
205 585fb430 2022-07-21 thomas topic branches which represent on-going work):
207 585fb430 2022-07-21 thomas * `main` -- this is the branch that tracks (without modification) those
208 585fb430 2022-07-21 thomas changes from `upstream`. This branch is continually reset to
209 585fb430 2022-07-21 thomas `upstream/main` whenever changes occur.
211 04dafe6d 2023-03-10 thomas * `portable` -- this is the *default* branch of the `-portable` repository which
212 585fb430 2022-07-21 thomas contains portable-specific changes to make `GoT` compile across different
215 585fb430 2022-07-21 thomas When updating `-portable` from upstream changes, the following actions happen:
217 585fb430 2022-07-21 thomas 1. Changes from `upstream` are fetched. If there are no new changes, there's
218 585fb430 2022-07-21 thomas nothing else to do.
219 585fb430 2022-07-21 thomas 2. Changes from `gh` are fetch so that the result can be pushed out to `gh`.
220 585fb430 2022-07-21 thomas 3. The difference between the local copy of `main` and `origin/main` is used
221 585fb430 2022-07-21 thomas to represent the set of commits which have *NOT* yet been merged to
222 585fb430 2022-07-21 thomas `-portable`.
223 04dafe6d 2023-03-10 thomas 4. A topic-branch called `syncup` is created from the HEAD of the `portable`
224 585fb430 2022-07-21 thomas branch to hold the to-be-cherry-picked commits from step 3.
225 585fb430 2022-07-21 thomas 5. These commits are then cherry-picked to the `syncup` branch.
226 585fb430 2022-07-21 thomas 6. If there's any conflicts, they must be resolved.
227 585fb430 2022-07-21 thomas 7. Once done, a sanity build is done in-situ to check there's nothing amiss.
228 04dafe6d 2023-03-10 thomas 8. If that succeeds, the `syncup` branch is merged to `portable` and pushed to
229 585fb430 2022-07-21 thomas `gh` for verification against CI.
230 585fb430 2022-07-21 thomas 9. If that fails, fixes continue and pushed up to `gh` as required.
231 04dafe6d 2023-03-10 thomas 10. Once happy, both the `main` and `portable` branches can be merged to `origin`.
233 585fb430 2022-07-21 thomas These steps are encapsulated in a script within `-portable`. [Link](../maintscripts/sync-upstream.sh)
235 ce0dfd3b 2022-07-21 thomas RELEASING A NEW VERSION
236 ce0dfd3b 2022-07-21 thomas =======================
238 ce0dfd3b 2022-07-21 thomas Release for `-portable` try and align as close to upstream GoT as much as
239 ce0dfd3b 2022-07-21 thomas possible, even on the same day where that can happen. That being said,
240 ce0dfd3b 2022-07-21 thomas sometimes a release of `-portable` might happen outside of that cadence, where
241 ce0dfd3b 2022-07-21 thomas a `-portable`-specific issue needs addressing, for example.
243 ce0dfd3b 2022-07-21 thomas Before creating a new release, check the version of GoT as found in
244 598139dd 2022-07-22 thomas `util/got-portable-ver.sh` -- as `GOT_PORTABLE_VER`:
247 598139dd 2022-07-22 thomas GOT_PORTABLE_VER=0.75
251 ce0dfd3b 2022-07-21 thomas Here, the *to be released* version of `got-portable` will be `0.75`.
252 ce0dfd3b 2022-07-21 thomas Typically, this version is incremented directly after a release, such that
253 ce0dfd3b 2022-07-21 thomas there's no need to change this value. The only exception would be if there
254 ce0dfd3b 2022-07-21 thomas were an out-of-band release to `-portable`. In such cases, that would take
255 ce0dfd3b 2022-07-21 thomas the form:
261 529beb87 2022-09-23 thomas Where the suffix of `1`, `2`, etc., can be used to denote any sub-releases
262 ce0dfd3b 2022-07-21 thomas from the `0.75` version.
264 05345ace 2022-09-10 thomas The variable `GOT_RELEASE` needs be changed to `yes` so that the
265 05345ace 2022-09-10 thomas GOT_PORTABLE_VER is asserted correctly.
267 04dafe6d 2023-03-10 thomas Once the version is verified, the following should be run from the `portable`
268 ce0dfd3b 2022-07-21 thomas branch -- and the repository should not have any outstanding modifications to
269 ce0dfd3b 2022-07-21 thomas the source:
272 ce0dfd3b 2022-07-21 thomas make clean ; ./autogen && ./configure && make distcheck
275 ce0dfd3b 2022-07-21 thomas If this succeeds, the tarball is in the CWD, as: `got-portable-VERSION.tar.gz`
277 ce0dfd3b 2022-07-21 thomas This can then be copied to the `got-www` repository and uploaded, along with
278 ce0dfd3b 2022-07-21 thomas changing a couple of HTML pages therein to represent the new released version.
279 ce0dfd3b 2022-07-21 thomas Additionally, the CHANGELOG file can be copied to the `got-www` and committed.
281 529beb87 2022-09-23 thomas Once all of that has been done, the repository should be tagged to indicate
282 529beb87 2022-09-23 thomas the release, hence:
285 529beb87 2022-09-23 thomas git tag -a 0.75
288 529beb87 2022-09-23 thomas This can then be pushed out to `gh` and `origin`.
290 529beb87 2022-09-23 thomas After that point, the version of `GOT_PORTABLE_VER` in
291 529beb87 2022-09-23 thomas `util/got-portable-ver.sh` should be changed to the next version, and
292 529beb87 2022-09-23 thomas `GOT_RELEASE` should be setg back to `no`.
297 00ced238 2021-09-24 thomas This port is incomplete in that only got(1) and tog(1) have been ported.
298 00ced238 2021-09-24 thomas gotweb has yet to be ported.
300 00ced238 2021-09-24 thomas configure.ac should start defining AC_ENABLE arguments to allow for
301 00ced238 2021-09-24 thomas finer-grained control of where to search for includes/libraries, etc.
306 585fb430 2022-07-21 thomas Thomas Adam <thomas@xteddy.org><br />
307 00ced238 2021-09-24 thomas thomas_adam (#gameoftrees on irc.libera.chat)
309 585fb430 2022-07-21 thomas [1] https://gameoftrees.org<br />
310 585fb430 2022-07-21 thomas [2] https://lists.openbsd.org/cgi-bin/mj_wwwusr?user=&passw=&func=lists-long-full&extra=gameoftrees<br />
311 585fb430 2022-07-21 thomas [3] https://github.com/ThomasAdam/got-portable
