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
|
Guidelines to develop OASIS
===========================
Updates in _oasis:
_oasis and setup.ml of the OASIS project need to be updated with the officialy
released version of OASIS.
__You should never use the version of OASIS under development to update__
Go to http://oasis.forge.ocamlcore.org/ and install the latest available
version.
The reason of that decision is that if you generate a new version of setup.ml
using your current version, each commit will include a change in setup.ml and
it will be mostly a repetition of something you write elsewhere in your commit.
Moreover, it can lead to conflict and it is never good to have to worry about
conflicts (it has generated unreconciliable changes when the project was using
darcs).
Creating plugins
================
TODO: complete
There are two kind of plugin:
* command line plugins: they create subcommand for the command line interface
of `oasis`. For example, the subcommand `oasis install pkg_name` is provided
by the plugin `install`.
* plugin that are used in `_oasis`: these plugins help to process the content
of an `_oasis` file. They generate additional content in `setup.ml` and so on.
You don''t have to load them, they will be automatically loaded when they are
found in the `_oasis` file. For example `Plugins: AutoGenerate (0.1)` in the
`_oasis` file will trigger the load of the plugin `autogenerate`.
The plugin system of `oasis` use findlib to detect plugins, so you must install
plugins as a standard OCaml library with a META file. OASIS detects plugin when
they have a field `plugin_system = "oasis"` or `plugin_system = "oasis-cli"` in
their META file.
Plugins are loaded as needed. You can ignore plugins with the command line options
`-ignore-plugins`.
Cut a release
=============
* Check status on [Jenkins][jenkins].
* Run headache.
* Update CHANGES.txt:
* git log 0.4.2..HEAD >> CHANGES.txt
* Date, first entry must be "Version X.Y.Z".
* Major/Minor changes.
* Thanks section.
* Create [blog post][blog-post].
* `make deploy`
* Update Change Log in the Files section of forge:
* Copy-paste last entry of CHANGES.txt.
* Don''t Merge lines of para.
* Check 'Preserve my pre-formatted text.'
* Check the result.
* Add new version to trackers ([Bugs][bugs-version]/[Patches][patches-version]).
* Close all bugs in the CHANGES.txt on trackers ([1][bugs], [2][patches]).
* Publish blog post with updated download links.
* G+ announce as OASIS.
* Reshare G+ post on OCaml community.
* Send mail to caml-list, oasis-devel.
* Run 'oasis setup' with the new version, inside oasis/ and commit the changes.
[jenkins]: http://deci.ovh.le-gall.net:8080/job/ocaml-oasis/
[blog-post]: http://le-gall.net/sylvain+violaine/blog/admin/posts.php
[bugs-version]: https://forge.ocamlcore.org/tracker/admin/index.php?add_opt=1&boxid=995&group_id=54&atid=291
[patches-version]: https://forge.ocamlcore.org/tracker/admin/index.php?add_opt=1&boxid=1007&group_id=54&atid=293
[bugs]: https://forge.ocamlcore.org/tracker/?atid=291&group_id=54&func=browse
[patches]: https://forge.ocamlcore.org/tracker/?atid=293&group_id=54&func=browse
Versions support policy
=======================
Since OASIS should allow to compile projects in most environment, it should not
set constraint on dependencies too high. Here are some policies, to determine
what version of a dependencies we should support:
* For generated setup.ml:
* No deps (standalone) except OCaml
* OCaml version must be at least the one in Debian stable.
* For generated files (e.g. myocamlbuild.ml):
* Version of the target in Debian stable or that matches the constraint
express in _oasis. E.g. if OCamlVersion: >= 4.01, we can generate
myocamlbuild.ml for this specific version because the constraint will be
checked at configure time.
* For the OASIS sources:
* OCaml version in Debian stable.
* All deps must be in Debian stable.
* Exception for related projects: ocamlmod, ocamlify, ocaml-data-notation
* For the OASIS tests:
* Version published, no strong requirement since tests can be disabled.
OASIS backward compatibility
============================
OASIS supports former version of OASISFormat. Most of the important things are
automatically backported to former version. However on the long term we might
decide to drop support of old OASISFormat.
We will support as long as possible an OASISFormat version but for any version
below the OASIS version present in Debian stable, we may drop the support.
For example:
* Debian stable is released with OASIS 0.2.0
* We may support OASISFormat: 0.1 as long as possible but, at one point we may
enforce at least OASISFormat: 0.2.
A list of supported OASISFormat can be found in OASISPackage_intern.ml.
Debian relationship
===================
We often use Debian, especially for version reference. OCaml support in Debian
has a long history and we need to pick one reference. Since one of the upstream
author is related to Debian, we made the decision to synchronize on Debian
stable release.
|
