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