Update releasing notes based on 2.7.4b1

jeff5 · jeff5 · commit 8889e026f9e8 · 2024-04-03T09:22:06.000+01:00
diff --git a/release_jy.rst b/release_jy.rst
@@ -74,7 +74,7 @@ At the same time, let's check that we have the tools we need on the path:
     gpg (GnuPG) 2.3.3
     libgcrypt 1.9.4
     PS git> git --version
-    git version 2.26.2.windows.1
+    git version 2.39.0.windows.2
 
 
 Clone the Repository
@@ -96,10 +96,10 @@ the last commits should be the same as in the project repository:
 ..  code-block:: ps1con
 
     PS work> git log --oneline --graph -4
-    * f17fc25c3 (HEAD -> master, origin/master, origin/HEAD) Support vararg constructors (#201)
-    * 98953f713 Prepare for work on v2.7.3b2.
-    * da3bfb368 (tag: v2.7.3b1) Prepare for 2.7.3b1 release.
-    * 257d6cb6d Use language-neutral locale to infer Python class name
+    * c6a7d5754 (HEAD -> master, origin/master, origin/HEAD) Exclude Guava META-INF
+    * 2c3834e21 Check Contributor Agreement (#308)
+    * f0afabba2 Fix shading (#317)
+    * bc9d8592a Updates to NEWS and README
 
 .. _changes-preparing-for-a-release:
 
@@ -118,11 +118,11 @@ The following files may need to be updated to match the version you are about to
   * ``jython.release_serial``.
 
   In the language of these properties,
-  version 2.7.3rc1 is spelled ``2``, ``7``, ``3``, ``${PY_RELEASE_LEVEL_GAMMA}``, ``1``.
+  version 2.7.4b1 is spelled ``2``, ``7``, ``4``, ``${PY_RELEASE_LEVEL_BETA}``, ``1``.
   Every other expression needing a version number is derived from these 5 values.
 * ``build.gradle``: The version number appears as a simple string property ``version``,
   near the top of the file.
-  Version 2.7.3rc1 is simply set like this: ``version = '2.7.3rc1'``.
+  Version 2.7.4b1 is simply set like this: ``version = '2.7.4b1'``.
 * ``src/org/python/core/imp.java``: If there has been any compiler change,
   increment the magic number ``APIVersion``.
   This magic declares old compiled files incompatible, forcing a fresh compilation for users.
@@ -144,7 +144,7 @@ The following files may need to be updated to match the version you are about to
           - [ NNNN ] ...
 
   Replace the first line with the release you are building
-  e.g. "Jython 2.7.3rc1".
+  e.g. "Jython 2.7.4b1".
   Add anything necessary to the section "New Features".
   After publication (not now),
   we will add a new, empty, section for the version then under development.
@@ -180,9 +180,9 @@ If you changed anything, commit this set of changes locally:
             modified:   build.gradle
             modified:   build.xml
 
-    $ git commit -m"Prepare for 2.7.3rc1 release."
-    [master 63359da88] Prepare for 2.7.3rc1 release.
-     3 files changed, 6 insertions(+), 6 deletions(-)
+    $ git commit -m"Prepare for 2.7.4b1 release."
+    [master 228fe9ef9] Prepare for 2.7.4b1 release.
+     3 files changed, 4 insertions(+), 4 deletions(-)
 
 
 Get the JARs
@@ -222,14 +222,13 @@ Run the ``full-check`` target, which does some simple checks on the repository:
 
     force-snapshot-if-polluted:
          [echo]
-         [echo] Change set 63359da88 is not tagged 'v2.7.3rc1' - build is a snapshot.
+         [echo] Change set 228fe9ef9 is not tagged 'v2.7.4b1' - build is a snapshot.
 
     dump:
          [echo] --- build Jython version ---
-         [echo] jython.version.short      = '2.7.3'
-         [echo] jython.release            = '2.7.3rc1'
-         [echo] jython.version            = '2.7.3rc1-SNAPSHOT'
-
+         [echo] jython.version.short      = '2.7.4'
+         [echo] jython.release            = '2.7.4b1'
+         [echo] jython.version            = '2.7.4b1-SNAPSHOT'
          [echo] --- optional libraries ---
          [echo] informix                  = '../support/jdbc-4.50.8.jar'
          [echo] oracle                    = '../support/ojdbc8-19.14.0.0.jar'
@@ -263,7 +262,7 @@ being careful to observe the conventional pattern
 
 ..  code-block:: ps1con
 
-    PS work> git tag -a -s v2.7.3rc1 -m"Jython 2.7.3rc1"
+    PS work> git tag -a -s v2.7.4b1 -m"Jython 2.7.4b1"
 
 This may open a pop-up from GPG
 that requires a password to unlock your signing key
@@ -274,7 +273,7 @@ It will need to be pushed eventually,
 but the current state of your repository is still at the change set tagged.
 If something goes wrong after this point but before the eventual push to the repository,
 that requires changes and a fresh commit,
-it is possible to delete the tag with ``git tag -d v2.7.3rc1``,
+it is possible to delete the tag with ``git tag -d v2.7.4b1``,
 and make it again at the new tip when you're ready.
 The Git book explains why you should not `delete a tag after the push`_.
 
@@ -310,9 +309,9 @@ Run the ``full-check`` target again:
     PS work> ant full-check
     Buildfile: D:\git\work\build.xml
 
-         [echo] Build is for release of 2.7.3rc1.
+         [echo] Build is for release of 2.7.4b1.
 
-         [echo] jython.version            = '2.7.3rc1'
+         [echo] jython.version            = '2.7.4b1'
 
 This time the script confirms it is a release
 and the version appears without the "SNAPSHOT" qualifier.
@@ -352,7 +351,7 @@ working in folder ``./build2``.
 
     PS work> .\gradlew --console=plain publish
     > Task :generateVersionInfo
-    This build is for v2.7.3rc1.
+    This build is for v2.7.4b1.
 
     > Task :generateGrammarSource
     ...
@@ -374,13 +373,13 @@ working in folder ``./build2``.
     > Task :publishMainPublicationToStagingRepoRepository
     > Task :publish
 
-    BUILD SUCCESSFUL in 6m 2s
+    BUILD SUCCESSFUL in 7m 1s
     16 actionable tasks: 16 executed
 
 Don't worry, this doesn't actually *publish* Jython.
 When the build finishes, a JAR that is potentially fit to publish,
 and its subsidiary artifacts (source, javadoc, checksums),
-will have been created in ``./build2/stagingRepo/org/python/jython-slim/2.7.3rc1``.
+will have been created in ``./build2/stagingRepo/org/python/jython-slim/2.7.4b1``.
 
 It can also be "published" to your local Maven cache (usually ``~/.m2/repository``
 with the task ``publishMainPublicationToMavenLocal``.
@@ -400,9 +399,9 @@ Let's use Java 11, different from the version we built with.
 
 ..  code-block:: ps1con
 
-    PS 273rc1-trial> mkdir kit
-    PS 273rc1-trial> copy "D:\git\work\dist\jython*.jar" .\kit
-    PS 273rc1-trial> java -jar kit\jython-installer.jar
+    PS 274b1-trial> mkdir kit
+    PS 274b1-trial> copy "D:\git\work\dist\jython*.jar" .\kit
+    PS 274b1-trial> java -jar kit\jython-installer.jar
     WARNING: An illegal reflective access operation has occurred
     ...
     DEPRECATION: A future version of pip will drop support for Python 2.7.
@@ -413,19 +412,19 @@ It is worth checking the manifests:
 
 ..  code-block:: ps1con
 
-    PS 273rc1-trial> jar -xf .\kit\jython-standalone.jar META-INF
-    PS 273rc1-trial> cat .\META-INF\MANIFEST.MF
+    PS 274b1-trial> jar -xf .\kit\jython-standalone.jar META-INF
+    PS 274b1-trial> cat .\META-INF\MANIFEST.MF
     Manifest-Version: 1.0
     Ant-Version: Apache Ant 1.10.12
     Created-By: 1.8.0_321-b07 (Oracle Corporation)
     Main-Class: org.python.util.jython
     Built-By: Jeff
     Implementation-Vendor: Python Software Foundation
     Implementation-Title: Jython fat jar with stdlib
-    Implementation-Version: 2.7.3rc1
+    Implementation-Version: 2.7.4b1
 
     Name: Build-Info
-    version: 2.7.3rc1
+    version: 2.7.4b1
     git-build: true
     oracle: true
     informix: true
@@ -443,10 +442,10 @@ The real test consists in running the regression tests:
 
 ..  code-block:: ps1con
 
-    PS 273rc1-trial> inst\bin\jython -m test.regrtest -e
-    == 2.7.3rc1 (tags/v2.7.3rc1:63359da88, Aug 28 2022, 07:26:35)
+    PS 274b1-trial> inst\bin\jython -m test.regrtest -e
+    == 2.7.4b1 (tags/v2.7.4b1:228fe9ef9, Apr 1 2024, 20:04:13)
     == [Java HotSpot(TM) 64-Bit Server VM (Oracle Corporation)]
-    == platform: java11.0.13
+    == platform: java11.0.22
     == encodings: stdin=ms936, stdout=ms936, FS=utf-8
     == locale: default=('en_GB', 'windows-1254'), actual=(None, None)
     test_grammar
@@ -480,34 +479,48 @@ When the author last tried, they were these:
 
 ..  code-block:: ps1con
 
-    PS 273rc1-trial> copy -r inst\Lib\test TestLib\test
-    PS 273rc1-trial> $env:JYTHONPATH = ".\TestLib"
-    PS 273rc1-trial> java -jar .\kit\jython-standalone.jar -m test.regrtest -e
-    == 2.7.3rc1 (tags/v2.7.3rc1:63359da88, Aug 28 2022, 07:26:35)
+    PS 274b1-trial> copy -r inst\Lib\test TestLib\test
+    PS 274b1-trial> $env:JYTHONPATH = ".\TestLib"
+    PS 274b1-trial> java -jar kit\jython-standalone.jar -m test.regrtest -e
+    == 2.7.4b1 (tags/v2.7.4b1:228fe9ef9, Apr 1 2024, 20:04:13)
     == [Java HotSpot(TM) 64-Bit Server VM (Oracle Corporation)]
-    == platform: java11.0.13
+    == platform: java11.0.22
     == encodings: stdin=ms936, stdout=ms936, FS=utf-8
     == locale: default=('en_GB', 'windows-1254'), actual=(None, None)
     test_grammar
     test_opcodes
     ...
+    test_zlib
+    test_zlib_jy
     338 tests OK.
     17 tests skipped:
         test_codecmaps_hk test_coerce_jy test_curses test_dict2java
         test_exceptions_jy test_java_integration test_java_subclasses
         test_java_visibility test_jbasic test_joverload test_jy_internals
         test_set_jy test_smtpnet test_socketserver test_subprocess
         test_urllib2net test_urllibnet
-    ...
-    32 fails unexpected:
+    10 skips unexpected:
+        test_coerce_jy test_dict2java test_exceptions_jy
+        test_java_integration test_java_subclasses test_java_visibility
+        test_jbasic test_joverload test_jy_internals test_set_jy
+    33 tests failed:
         test_argparse test_classpathimporter test_cmd_line
         test_cmd_line_script test_codecs_jy test_compile_jy test_email_jy
         test_email_renamed test_gc_jy test_httpservers test_import
         test_import_jy test_json test_jython_initializer
         test_jython_launcher test_lib2to3 test_linecache test_marshal
         test_os_jy test_pdb test_platform test_popen test_quopri test_repr
-        test_site test_site_jy test_ssl_jy test_sys test_threading
-        test_urllib2 test_warnings test_zipimport_support
+        test_site test_site_jy test_ssl_jy test_sys test_sys_jy
+        test_threading test_urllib2 test_warnings test_zipimport_support
+    33 fails unexpected:
+        test_argparse test_classpathimporter test_cmd_line
+        test_cmd_line_script test_codecs_jy test_compile_jy test_email_jy
+        test_email_renamed test_gc_jy test_httpservers test_import
+        test_import_jy test_json test_jython_initializer
+        test_jython_launcher test_lib2to3 test_linecache test_marshal
+        test_os_jy test_pdb test_platform test_popen test_quopri test_repr
+        test_site test_site_jy test_ssl_jy test_sys test_sys_jy
+        test_threading test_urllib2 test_warnings test_zipimport_support
 
 Most of these failures are in tests that assume
 the library is a real file system.
@@ -541,7 +554,7 @@ such as your personal Maven cache:
     PS work> .\gradlew --console=plain publishMainPublicationToMavenLocal
 
 This will deliver build artifacts to
-``~/.m2/repository/org/python/jython-slim/2.7.3rc1``.
+``~/.m2/repository/org/python/jython-slim/2.7.4b1``.
 One can construct an application to run with that as a dependency like this:
 
 ..  code-block:: groovy
@@ -557,7 +570,7 @@ One can construct an application to run with that as a dependency like this:
     }
 
     dependencies {
-        implementation 'org.python:jython-slim:2.7.3rc1'
+        implementation 'org.python:jython-slim:2.7.4b1'
     }
 
     application {
@@ -587,6 +600,28 @@ Tests have about the same success rate as for the stand-alone Jython JAR.
 Notably ``test_ssl_jy`` passes here because a genuine (not wrapped)
 Bouncy Castle JAR is on the path.
 
+Tests end with a failure status under Gradle, even when all tests pass,
+because ``regrtest`` calls ``sys.exit``,
+which raises ``SystemExit``.
+They look like:
+
+..  code-block:: text
+
+
+    All 2 tests OK.
+    Exception in thread "MainThread" Traceback (most recent call last):
+      File "<string>", line 1, in <module>
+      File ".\TestLib\test\regrtest.py", line 521, in main
+        sys.exit(surprises > 0)
+    SystemExit: False
+
+    > Task :run FAILED
+
+    FAILURE: Build failed with an exception.
+
+One could improve the driver program, but it is complicated to do properly.
+
+
 .. _jython-push-with-tag:
 
 Only now is it safe to ``git push``
@@ -629,10 +664,10 @@ During the build, ``gpg`` may prompt you (in a dialogue box)
 for the pass-phrase that protects your private signing key.
 This leaves the following new artifacts in ``./publications``:
 
-* ``jython-2.7.3rc1-bundle.jar``
-* ``jython-standalone-2.7.3rc1-bundle.jar``
-* ``jython-installer-2.7.3rc1-bundle.jar``
-* ``jython-slim-2.7.3rc1-bundle.jar``
+* ``jython-2.7.4b1-bundle.jar``
+* ``jython-standalone-2.7.4b1-bundle.jar``
+* ``jython-installer-2.7.4b1-bundle.jar``
+* ``jython-slim-2.7.4b1-bundle.jar``
 
 
 Publication
@@ -670,10 +705,10 @@ which now appears to have been updated with the changes.
     PS work> gpg --list-secret-keys
     C:\Users\Jeff\AppData\Roaming\gnupg\pubring.kbx
     -----------------------------------------------
-    sec   rsa2048 2019-10-20 [SC] [expires: 2024-11-20]
+    sec   rsa2048 2019-10-20 [SC] [expires: 2028-02-26]
           C8C4B9DC1E031F788B12882B875C3EF9DC4638E3
     uid           [ultimate] Jeff Allen <ja.py@farowl.co.uk>
-    ssb   rsa2048 2019-10-20 [E] [expires: 2023-11-21]
+    ssb   rsa2048 2019-10-20 [E] [expires: 2028-02-26]
 
 The `OpenPGP key server`_ provides an interface to query
 a PGP public key.
@@ -682,7 +717,8 @@ It may take a few hours for your key to wash up at the machine
 Sonatype consults.
 
 Generation and publication of a key are one-time actions,
-except that the key has a finite lifetime (2 years here).
+except that the key has a finite lifetime with possible extensions.
+(The key here has been extended twice.)
 See `Working with PGP Signatures`_ for how to extend the life of a key.
 
 .. note:: You may decide to create a new key for signing future releases.
@@ -708,10 +744,10 @@ You are now ready to upload bundles acceptable to Sonatype.
   select "Artifact Bundle".
 * Navigate to the ``./publications`` folder and upload in turn:
 
-  * ``jython-slim-2.7.3rc1-bundle.jar``
-  * ``jython-2.7.3rc1-bundle.jar``
-  * ``jython-standalone-2.7.3rc1-bundle.jar``
-  * ``jython-installer-2.7.3rc1-bundle.jar``
+  * ``jython-slim-2.7.4b1-bundle.jar``
+  * ``jython-2.7.4b1-bundle.jar``
+  * ``jython-standalone-2.7.4b1-bundle.jar``
+  * ``jython-installer-2.7.4b1-bundle.jar``
 
   For some reason (privacy?) the display shows a fake file path
   but the name is correct.
@@ -789,17 +825,24 @@ We do not know for sure the version next to be publicly released,
 so we use the smallest increment that results in a valid version number.
 
 After an alpha, beta or release candidate,
-assume the successor version to be a one-up serial of the same release level,
+assume the successor version to be a one-up serial of the *same* release level,
 incrementing ``jython.release_serial``.
 After a final release,
 assume the successor to be an alpha of the next micro-release.
 For example, ``2.7.2b2`` is followed by ``2.7.2b3``,
 and ``2.7.2`` by ``2.7.3a1``.
 
-If the version under development is ``2.7.3b2``,
-the build system will label the code as ``2.7.3b2-DEV`` in the developer build.
-If you build an installer, or dry-run a release, it will be ``2.7.3b2-SNAPSHOT``.
-You can read this as a version that "may eventually become" ``2.7.3b2`` etc..
+If the version under development is ``2.7.4b2``,
+the build system will label the code as ``2.7.4b2-DEV`` in the developer build.
+If you build an installer, or dry-run a release, it will be ``2.7.4b2-SNAPSHOT``.
+You can read this as a version that "may eventually become" ``2.7.4b2`` etc..
+
+However, the version under development in this scheme will often be one that
+never sees a release.
+E.g. when we are apparently working on ``2.7.4b2``,
+the next release is quite likely to be ``2.7.4rc1`` instead,
+but we can't guarantee that things will go that well.
+It's a harmless paradox.
 
 Make this change in both ``build.xml`` and ``build.gradle``.
 See the section :ref:`changes-preparing-for-a-release` for details.
