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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
# Creating a SWI-Prolog release
This document summarises the steps and prerequisites to build a
SWI-Prolog release. Most of the scripts are in the `scripts` directory.
Many of these scripts contain paths and addresses that relate to how
things are setup on my development machines.
## Machines
Releases are currently build using a Linux machine running Ubuntu 20.04
and a Mac running MacOS 10.15. For a full release you need a Linux
machine and a Mac. With minor adjustments, any Linux distro will do, but
the hardware must be amd64 to be able to run Wine for building the
Windows releases.
## Preparing the build machines
This only needs to be done once. One must regularly check Windows and
MacOS dependencies for new releases, in particular for OpenSSL.
### Linux machine
- Install the [dependencies](https://www.swi-prolog.org/build/Debian.txt),
including those for building the PDF documentation
#### Preparing building Windows releases
- Clone https://github.com/SWI-Prolog/docker-swipl-build-mingw
- Build the docker image using
make image
### Mac
- Install Apple Xcode
- Install Macports
- Install these packages
- autoconf
- automake
- gnutar
- gsed
- gcc11 (when building for x86_64 only)
- cmake
- openjdk17
- Qt 6.2.2
- Build the SWI-Prolog dependencies according to `scripts/macos-deps.sh`
#### MacOS universal binaries
We assume the build is done on an M1 system.
- Build the dependencies for both x86_64 and arm64. Either on
machines with both architectures or using `clang -arch` option.
- Copy the x86_64 deps tree to ~/deps.x86_64.
- Go to `deps` and run
~/src/swipl-devel/scripts/macos-import-arch.sh ../deps.x86_64
- Verify you now have fat binaries using
lipo -info <some of the .dylib files>
- Macports openjdk17 is single-archirecture. Install both
architectures and use `lipo` to create a fat version of
`libjvm.dylib` for the M1 OpenJDK installation:
lipo -create libjvm.dylib.arm64 libjvm.dylib.x86_64 -output libjvm.dylib
- From there, the recipe in `scripts/make-distribution` does
the job.
## Accounts, etc
- Setup PGP signatures for git, so you can sign the release
- Setup upload channels for rsync to the website.
- Setup authentication for uploading to the Ubuntu PPA
## Preparing a release (on Linux, but could be adopted for Mac)
- Edit `VERSION` to specify the new release
- Run this command and tag+sign the release
./scripts/newversion
## Build the releases
- Create the releases. Below is if all is setup correctly. The
script `make-distribution` defines a lot of useful functions.
First time it may be wise to run the steps one-by-one.
. scripts/make-distribution
build
- For the Mac
- Pull the repo from the Linux machine, including tags and verify
the directory is clean and in sync:
git pull linux master
git pull --tags linux master
git describe
- Build as for Linux:
. scripts/make-distribution
build
- If there were no issues with any of the builds we can go to the
next step. If there are issues, fix them and repeat all steps,
starting with `./scripts/newversion`
## Uploading the releases
- Run the `upload` function as defined by `make-distribution`.
This assumes the upload rsync channels are setup properly.
- Upload the git repos:
git push
git push --tags
git submodule foreach git push --tags
## Updating the website
- Login to the webserver backends. The basic sequence is below.
Typically this also installs OS patches and reboot the server
after the software upgrade instead of just the web server.
cd src/swipl-devel
git pull
git describe # Verify tag
../scripts/pgo-compile.sh
ctest
ninja install
sudo systemctl restart plweb
## Updating the Linux snaps
- See snap/local/publish.md
## Updating Macports
- Assumes a clone of https://github.com/macports/macports-ports under ~/src
with a remote `fork` pointing at your fork of this repo at github. I have
this both on the Linux machine and Mac.
### Testing the Macports version
There is typically not that much need to verify the whole thing also
builds under Macports if you already built and tested the current
version on the Mac. Still, if there are problems proceed as follows:
- First time preparation
- Setup a local repository according to
https://guide.macports.org/chunked/development.local-repositories.html
- Create directories `lang/swi-prolog` and `lang/swi-prolog-devel` under
~/ports and from these dirs create a symlink to the `Portfile` files
in the `~/src/macports-ports` repo.
- Run `portindex` in ~/ports
Now, to test your version run these commands. The first creates a source
tar archive and the second publishes this in the local Macports
distfiles store and updates the version and hashes of the `Portfile`.
./scripts/make-src-tape --tag=HEAD
./scripts/update-macports
Now you can run
port lint swi-prolog-devel
sudo port test swi-prolog-devel
### Creating a PR
Go back to the Linux machine and run
./scripts/update-macports
This creates a branch with the version (say 8.3.1) in
~/src/macports-ports with the correct version and hashes. This is why
you need to run this on the Linux machine as you have uploaded the tar
archive from this machine. The one on the Mac isn't the same as time
stamps vary. Now
- cd ~/src/macports-ports
- Verify that lang/swi-prolog/devel/Portfile looks good using
git show HEAD
- Push the branch to our clone
git push fork $(git rev-parse --abbrev-ref HEAD)
- Open the link of the PR and complete it.
## Updating the official Docker image
### Preparation
- Fork https://github.com/SWI-Prolog/docker-swipl
- Fork https://github.com/docker-library/official-images
### Update docker-swipl
- cp -r <latest version> <new version>
- Edit <newversion>/bullseye/Dockerfile, e.g.
- SWIPL_VER=8.2.3; \
- SWIPL_CHECKSUM=9403972f9d87f1f4971fbd4a5644b4976b1b18fc174be84506c6b713bd1f9c93; \
- Test using
- `docker pull debian:bullseye-slim`
- `docker build . 2>&1 | tee build.log
- On success, add the Dockerfile and create a PR
### Update official-images
- Edit `library/swipl`, update
- GitCommit
- Tags
- Directory
- Commit with comment "Updated swipl (devel/stable) to <version>"
- Create a PR.
## Creating the Announce post
Create the basic ChangeLog, replacing the two releases (previous and
new) and edit the result, highlighting the important aspects:
mkdir -p ReleaseNotes
./scripts/mkchangelog --nodate 8.3.0 > ReleaseNotes/RELNOTES-8.3.1
edit ReleaseNotes/RELNOTES-8.3.1
Finally, copy/paste into a new release topic in Discourse.
|
