clpm/README-dev.org at master · lisp-mirror/clpm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#+TITLE: Developer README

This file is meant to be a colleciton of notes for CLPM developers that users
don't typically have to worry about.

* CI

  The canonical repo has Linux arm, Windows, and Mac runners associated with
  it. Since forks are unlikely to have these, the jobs that run on them are
  guarded by the presence of the environment variables =CLPM_CI_LINUX_ARM64=,
  =CLPM_CI_WINDOWS_AMD64=, and =CLPM_CI_MACOS_AMD64=.

* Dependencies

  CLPM has a lot of dependencies. Probably too many, but that's a problem for
  another day. CLPM has a habit of finding issues in its dependencies that
  sometimes take a while to get fixed. To support both getting the needed fixes
  before upstream merges them and to make builds reproducible, we use git
  submodules for all our dpeendencies.

  One day, I'd like to see CLPM self host itself so we can have a clpmfile.lock
  instead. But CLPM needs to get a little more stable first.

** Fixes

   This is a list of the fixes we have submitted upstream and their current
   status. For most of these, if there is an outstanding PR, CLPM pulls its
   code from a fork that has the PR merged. We don't necessarily depend on all
   these libraries any more, but PRs are kept for posterity.

   - cl-plus-ssl ::
     - [ ] https://github.com/cl-plus-ssl/cl-plus-ssl/pull/116 (likely
       rejected. seems to not play well with some implementations that already
       load an SSL library).
     - [X] https://github.com/cl-plus-ssl/cl-plus-ssl/pull/115 (not submitted
       by us, but needed by us)
   - osicat ::
     - [X] https://github.com/osicat/osicat/pull/39
   - dexador ::
     - [ ] https://github.com/fukamachi/dexador/pull/86
     - [ ] https://github.com/fukamachi/dexador/issues/87
   - cffi ::
     - [ ] https://github.com/cffi/cffi/pull/141
   - zippy ::
     - [X] https://github.com/Shinmera/zippy/pull/1
   - cl-unicode ::
     - [X] https://github.com/edicl/cl-unicode/pull/26
   - archive :: There doesn't seem to be any active upstream for this
     project... May try sending some merge requests to sharplispers, but if
     that fails, CLPM may have to hard fork/try to assume ownership.
   - cl-semver ::
     - [X] https://github.com/cldm/cl-semver/pull/4
     - [X] https://github.com/cldm/cl-semver/pull/5
   - deploy ::
     - [X] https://github.com/Shinmera/deploy/pull/12
     - [X] https://github.com/Shinmera/deploy/pull/13
   - mito ::
     - [X] https://github.com/fukamachi/mito/pull/53