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