Skip to content

Commit

Permalink
Add changes for 6aa4a15
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Sep 25, 2024
1 parent 743f267 commit 284f469
Show file tree
Hide file tree
Showing 10 changed files with 163 additions and 109 deletions.
106 changes: 59 additions & 47 deletions How2Guides/UPGRADING.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,22 +65,23 @@
<li class="toctree-l2 current"><a class="current reference internal" href="#">Release Notes (Advice on Upgrades)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#installation-instructions">Installation Instructions</a></li>
<li class="toctree-l3"><a class="reference internal" href="#git">git</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id1">3.0.54</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">3.0.53</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">3.0.52</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">3.0.51</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">3.0.47</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">3.0.45</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">3.0.41</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">3.0.40</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">3.0.37</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">3.0.26</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id11">3.0.25</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">3.0.23</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">3.0.22</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id14">3.0.17</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">3.0.15</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id16">3.0.14</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id1">3.0.56</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">3.0.54</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">3.0.53</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">3.0.52</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">3.0.51</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">3.0.47</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">3.0.45</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">3.0.41</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">3.0.40</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">3.0.37</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id11">3.0.26</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">3.0.25</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">3.0.23</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id14">3.0.22</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">3.0.17</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id16">3.0.15</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id17">3.0.14</a></li>
<li class="toctree-l3"><a class="reference internal" href="#v2-to-sr3">V2 to Sr3</a></li>
</ul>
</li>
Expand Down Expand Up @@ -154,7 +155,18 @@ <h2>Installation Instructions<a class="headerlink" href="#installation-instructi
<h2>git<a class="headerlink" href="#git" title="Link to this heading"></a></h2>
</section>
<section id="id1">
<h2>3.0.54<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
<h2>3.0.56<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: code refactor <em>sarracenia.credentials…</em> classes are now
<em>sarracenia.config.credentials</em> any code using credentials need to be
updated.</p>
<p><em>CHANGE</em>: queue settings stored in subscriptions.json state file,
instead of a .qname file, along with more information. Transition
is perhaps complex. This version will read and write both files,
so as to preserve ability to downgrade. later version will drop
support for qname files.</p>
</section>
<section id="id2">
<h2>3.0.54<a class="headerlink" href="#id2" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: <em>sr3 sanity</em> only restarts missing instances, not stopped ones.
this is considered more in accordance with analyst expectations (POLA)</p>
<dl class="simple">
Expand All @@ -175,15 +187,15 @@ <h2>3.0.54<a class="headerlink" href="#id1" title="Link to this heading"></a>
<p>To understand whether they need queueShare in order
to keep the same sharing as previously obtained by default.</p>
</section>
<section id="id2">
<h2>3.0.53<a class="headerlink" href="#id2" title="Link to this heading"></a></h2>
<section id="id3">
<h2>3.0.53<a class="headerlink" href="#id3" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: <em>directory</em> option in poll will no longer be converted to <em>path</em> silently.
Use <em>path</em> explicitly instead. It is still converted when upgrading from v2 with
<em>sr3 convert</em>, but in v3 configurations, <em>directory</em> now acts as it does in all other
components as a download specifier.</p>
</section>
<section id="id3">
<h2>3.0.52<a class="headerlink" href="#id3" title="Link to this heading"></a></h2>
<section id="id4">
<h2>3.0.52<a class="headerlink" href="#id4" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: Additional messageCountMax arugment to flowcb.gather() entry point.
when implementing flow callbacks for scheduled flows, or poll overrides, the
gather entry point now takes one additional argument indicating the maximum
Expand All @@ -196,16 +208,16 @@ <h2>3.0.52<a class="headerlink" href="#id3" title="Link to this heading"></a>
<p>With the default value, plugins are downward compatible. (earlier versions
will call with only self as an argument.)</p>
</section>
<section id="id4">
<h2>3.0.51<a class="headerlink" href="#id4" title="Link to this heading"></a></h2>
<section id="id5">
<h2>3.0.51<a class="headerlink" href="#id5" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: Additional <em>action</em> argument sarracenia.config.one_config() indicating
how the configuration will be used. When used for readonly operations (status,
show, dump) the configuration should avoid filling values that should only
be defines when used. Examples have been updated appropriately.</p>
<p><em>CHANGE</em>: <em>action</em> setting now mandatory for the sarracenia.config.finalize().</p>
</section>
<section id="id5">
<h2>3.0.47<a class="headerlink" href="#id5" title="Link to this heading"></a></h2>
<section id="id6">
<h2>3.0.47<a class="headerlink" href="#id6" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: config option, strftime options, offset grammar changed:
in v2 you had ${YYYYMMDD-70m}, in sr3 it should be ${%o-70m%Y%m%d}
in 3.0.47, moved the time offset parsing to the beginning of the pattern.</p>
Expand All @@ -215,15 +227,15 @@ <h2>3.0.47<a class="headerlink" href="#id5" title="Link to this heading"></a>
is the same as used by v2, so it should improve compatibility with
sarracenia v2 configurations.</p>
</section>
<section id="id6">
<h2>3.0.45<a class="headerlink" href="#id6" title="Link to this heading"></a></h2>
<section id="id7">
<h2>3.0.45<a class="headerlink" href="#id7" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>CHANGE</em>: config option: logRotateInterval units was days, is now</dt><dd><p>a time interval (seconds) like all other intervals.</p>
</dd>
</dl>
</section>
<section id="id7">
<h2>3.0.41<a class="headerlink" href="#id7" title="Link to this heading"></a></h2>
<section id="id8">
<h2>3.0.41<a class="headerlink" href="#id8" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: v03 post format field renamed: “integrity” is now “identity”</p>
<blockquote>
<div><ul class="simple">
Expand All @@ -235,8 +247,8 @@ <h2>3.0.41<a class="headerlink" href="#id7" title="Link to this heading"></a>
</ul>
</div></blockquote>
</section>
<section id="id8">
<h2>3.0.40<a class="headerlink" href="#id8" title="Link to this heading"></a></h2>
<section id="id9">
<h2>3.0.40<a class="headerlink" href="#id9" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>CHANGE</em>: the default format in which messages are posted is v03, but as of this</dt><dd><p>version, to override the format, one must use <em>post_format v02</em>
prior to this version, setting of post_topicPrefix was sufficient.
Expand Down Expand Up @@ -268,15 +280,15 @@ <h2>3.0.40<a class="headerlink" href="#id8" title="Link to this heading"></a>
</div></blockquote>
</div></blockquote>
</section>
<section id="id9">
<h2>3.0.37<a class="headerlink" href="#id9" title="Link to this heading"></a></h2>
<section id="id10">
<h2>3.0.37<a class="headerlink" href="#id10" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>BUG</em>: <em>sr3 cleanup</em> does not work at all.</dt><dd><p><a class="reference external" href="https://github.com/MetPX/sarracenia/issues/669">https://github.com/MetPX/sarracenia/issues/669</a></p>
</dd>
</dl>
</section>
<section id="id10">
<h2>3.0.26<a class="headerlink" href="#id10" title="Link to this heading"></a></h2>
<section id="id11">
<h2>3.0.26<a class="headerlink" href="#id11" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>CHANGE</em>: event options (logEvents, and fileEvents) now replace previous value</dt><dd><p>used to be unioned (or’d) with previous value. now can preface
the set elements with + to get the previous behaviour.
Expand All @@ -287,25 +299,25 @@ <h2>3.0.26<a class="headerlink" href="#id10" title="Link to this heading"></a
</dd>
</dl>
</section>
<section id="id11">
<h2>3.0.25<a class="headerlink" href="#id11" title="Link to this heading"></a></h2>
<section id="id12">
<h2>3.0.25<a class="headerlink" href="#id12" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>CHANGE</em>: default value for acceptUnmatched is now True for all components.</dt><dd><p>prior to this release, default was False in subscribe component,
and True for all others.</p>
</dd>
</dl>
</section>
<section id="id12">
<h2>3.0.23<a class="headerlink" href="#id12" title="Link to this heading"></a></h2>
<section id="id13">
<h2>3.0.23<a class="headerlink" href="#id13" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>NOTICE</em>: now prefer strftime date specification in patterns, in place of</dt><dd><p>ones inherited from Sundew. converted by sr3 convert.</p>
</dd>
<dt><em>CHANGE</em>: removed <em>please_stop_immediately</em> option added in 3.0.22</dt><dd><p>(all components now stop more quickly, so not needed.)</p>
</dd>
</dl>
</section>
<section id="id13">
<h2>3.0.22<a class="headerlink" href="#id13" title="Link to this heading"></a></h2>
<section id="id14">
<h2>3.0.22<a class="headerlink" href="#id14" title="Link to this heading"></a></h2>
<p><em>CHANGE</em>: <em>destination</em>, when used in a poll is replaced by <em>pollUrl</em></p>
<p><em>CHANGE</em>: <em>destination</em>, when used in a sender is replaced by <em>sendTo</em></p>
<dl class="simple">
Expand All @@ -317,8 +329,8 @@ <h2>3.0.22<a class="headerlink" href="#id13" title="Link to this heading"></a
</dd>
</dl>
</section>
<section id="id14">
<h2>3.0.17<a class="headerlink" href="#id14" title="Link to this heading"></a></h2>
<section id="id15">
<h2>3.0.17<a class="headerlink" href="#id15" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>CHANGE</em>: The “Vendor” string is now “MetPX” instead of “science.gc.ca”.</dt><dd><p>This affects some file placement particularly on Windows.</p>
</dd>
Expand All @@ -330,8 +342,8 @@ <h2>3.0.17<a class="headerlink" href="#id14" title="Link to this heading"></a
</dd>
</dl>
</section>
<section id="id15">
<h2>3.0.15<a class="headerlink" href="#id15" title="Link to this heading"></a></h2>
<section id="id16">
<h2>3.0.15<a class="headerlink" href="#id16" title="Link to this heading"></a></h2>
<dl class="simple">
<dt><em>NOTICE</em>: re-instating debian and windows packages by removing hard requirements for python modules</dt><dd><p>which are difficult to satisfy. From 3.0.15, dependencies are modular.</p>
</dd>
Expand Down Expand Up @@ -367,8 +379,8 @@ <h2>3.0.15<a class="headerlink" href="#id15" title="Link to this heading"></a
</dd>
</dl>
</section>
<section id="id16">
<h2>3.0.14<a class="headerlink" href="#id16" title="Link to this heading"></a></h2>
<section id="id17">
<h2>3.0.14<a class="headerlink" href="#id17" title="Link to this heading"></a></h2>
<p>initial beta.</p>
<dl class="simple">
<dt><em>NOTICE</em>: only pip packages currently work. No Debian packages on launchpad.net</dt><dd><p>nor any windows packages.</p>
Expand Down
15 changes: 15 additions & 0 deletions _sources/How2Guides/UPGRADING.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ Installation Instructions
git
---

3.0.56
------

*CHANGE*: code refactor *sarracenia.credentials...* classes are now
*sarracenia.config.credentials* any code using credentials need to be
updated.

*CHANGE*: queue settings stored in subscriptions.json state file,
instead of a .qname file, along with more information. Transition
is perhaps complex. This version will read and write both files,
so as to preserve ability to downgrade. later version will drop
support for qname files.



3.0.54
------

Expand Down
4 changes: 2 additions & 2 deletions _sources/Reference/sr3_options.7.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1771,7 +1771,7 @@ appropriately.


scheduled_interval,scheduled_hour,scheduled_minute,scheduled_time
--------------------------------------------------
-----------------------------------------------------------------

When working with scheduled flows, such as polls, one can configure a duration
(no units defaults to seconds, suffixes: m-minute, h-hour) at which to run a
Expand All @@ -1798,7 +1798,7 @@ this will poll the data at 15:30, 16:30 and 18:59 every day. This option allows
your time field then previous options.

sendTo <url>
---------------
------------

Specification of a remote resource to deliver to in a sender.

Expand Down
14 changes: 14 additions & 0 deletions _sources/fr/CommentFaire/MiseANiveau.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,20 @@ Instructions d’installation
git
---

3.0.56
------

*CHANGEMENT* : refactorisation du code *sarracenia.credentials...* les classes sont désormais
*sarracenia.config.credentials* tout code utilisant des informations d'identification doit être
mis à jour.

*CHANGEMENT* : paramètres de file d'attente stockés dans le fichier d'état subscriptions.json,
au lieu d'un fichier .qname, avec plus d'informations. La transition
est peut-être complexe. Cette version lira et écrira les deux fichiers,
afin de préserver la possibilité de rétrogradation. La version ultérieure abandonnera
la prise en charge des fichiers qname.

3.0.54
------

Expand Down
4 changes: 2 additions & 2 deletions _sources/fr/Reference/sr3_options.7.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1770,8 +1770,8 @@ sanity_log_dead <intervalle> (défaut: 1.5*housekeeping)

L’option **sanity_log_dead** définit la durée à prendre en compte avant de redémarrer un composant.

scheduled_interval,scheduled_hour,scheduled_minute
--------------------------------------------------
scheduled_interval,scheduled_hour,scheduled_minute,scheduled_time
-----------------------------------------------------------------

Lorsque vous travaillez avec des flux cédulés, tels que des sondages, vous pouvez configurer une durée
(unité: seconde par défaut, suffixes : m-minute, h-heure) à laquelle exécuter un
Expand Down
Loading

0 comments on commit 284f469

Please sign in to comment.