You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/ReleaseMaking.asciidoc
+44-43Lines changed: 44 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,9 @@ This page describes the process of making a new https://github.com/pasdoc/pasdoc
9
9
10
10
## Change version number to next stable
11
11
12
-
* Change version of all packages in pasdoc/source/packages/ dir. Right now this means changing
13
-
**.../packages/lazarus/pasdoc_package.lpk
14
-
** all Delphi packages
15
-
* change VERSION in pasdoc/Makefile
16
-
* change PASDOC_VERSION and PASDOC_DATE in pasdoc/source/components/PasDoc_Versions.pas
12
+
* Change version of all packages in `source/packages/`. Right now this means just changing `source/packages/lazarus/pasdoc_package.lpk`. (Delphi packages don't store PasDoc version now.)
13
+
* change `VERSION` in `pasdoc/Makefile`
14
+
* change `PASDOC_VERSION` and `PASDOC_DATE` in `source/components/PasDoc_Versions.pas`
17
15
18
16
Make last version number _even_ to signify stable release, like `1.2.4`.
19
17
@@ -29,11 +27,31 @@ Remove from the documentation text
29
27
30
28
_Note that this feature is not available in latest released pasdoc version, x.y.z. You must download and compile pasdoc yourself or use link:DevelopmentSnapshots[DevelopmentSnapshots] to use this feature._
31
29
32
-
(where _x.y.z_ is version number of previous release) placed at the beginning of some pages. This is easily done by doing a full-text search in the wiki for the phrase __Note that this feature is not available in latest released pasdoc version__. (For GitHub wiki, you can clone it and then just grep locally.)
30
+
## Update AutoDoc
31
+
32
+
* It's a good idea to upload link:PasDocAutoDoc[PasDocAutoDoc] at this time, like this:
33
+
+
34
+
----
35
+
cd pasdoc/source/autodoc/
36
+
pasdoc --version # make sure latest version of pasdoc is used
37
+
make clean public upload
38
+
39
+
cd ../../../pasdoc.github.io/
40
+
git commit -m "Updated autodoc"
41
+
git push
42
+
----
43
+
44
+
## Prepare tag and GitHub release
45
+
46
+
* Create a tag by `make tag`.
47
+
48
+
* Go to https://github.com/pasdoc/pasdoc/releases and create a new release from this tag. Place the notes from the changelog entry as description. Make it "draft" for now.
33
49
34
50
## [[compile-and-test-all-releases]] Build and test all releases (automated now)
35
51
36
-
**Note: This step is in practice automated now, using https://github.com/castle-engine/castle-engine/wiki/Cloud-Builds-(Jenkins)[Castle Game Engine Jenkins infrastructure] to automatically test and build PasDoc. The commands performed by Jenkins are configured in `Jenkinsfile` in the PasDoc repository.**
52
+
Note: This step is automated now, using https://github.com/pasdoc/pasdoc/tree/master/.github/workflows[GitHub Actions] to automatically test and build PasDoc. Just switch `release_tag` in `.github/workflows/build.yml` to the new tag and push it, and GitHub Actions will do the rest.
53
+
54
+
Below we describe how to do things manually, just in case.
37
55
38
56
* Make sure you have the latest stable FPC and Lazarus versions.
39
57
@@ -50,18 +68,12 @@ To be sure, you should run these tests on all targets.
50
68
* To build for the current platform (OS and architecture) call this:
51
69
+
52
70
```
53
-
make clean build-fpc-default
71
+
make clean build-fpc-release
54
72
```
55
73
+
56
74
Note that it's important to call `clean` before `build-...`, otherwise you risk that some units were left as compiled with debug options.
57
75
+
58
-
To build for an indicated platform:
59
-
+
60
-
```
61
-
make clean build-fpc-<os/arch>
62
-
```
63
-
+
64
-
To build for indicated platform and package to zip/tar.gz (this will call `clean build-fpc-<os/arch>` as first steps):
76
+
To build for indicated platform and package to zip/tar.gz (this will call `clean build-fpc-release` as first steps):
0 commit comments