Skip to content

Commit

Permalink
Version 1.0.2
Browse files Browse the repository at this point in the history
Update version numbers and push the updated documentation.
  • Loading branch information
fadden committed Jun 24, 2024
1 parent 655c040 commit 52a7ac9
Show file tree
Hide file tree
Showing 12 changed files with 91 additions and 31 deletions.
2 changes: 1 addition & 1 deletion AppCommon/GlobalAppVersion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static class GlobalAppVersion {
/// Overall application version.
/// </summary>
public static readonly CommonUtil.Version AppVersion =
new CommonUtil.Version(1, 0, 2, CommonUtil.Version.PreRelType.Dev, 3);
new CommonUtil.Version(1, 0, 2, CommonUtil.Version.PreRelType.Final, 0);
// NOTE: there's an independent version in DiskArc/Defs.cs
}
}
2 changes: 1 addition & 1 deletion DiskArc/Defs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static class Defs {
/// DiskArc library version number.
/// </summary>
public static CommonUtil.Version LibVersion { get; } =
new CommonUtil.Version(1, 0, 1, CommonUtil.Version.PreRelType.Final, 0);
new CommonUtil.Version(1, 0, 2, CommonUtil.Version.PreRelType.Final, 0);

public const string BUILD_TYPE =
#if DEBUG
Expand Down
16 changes: 8 additions & 8 deletions Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ or use one of these links to download a recent stable release:

System | Self-Cont'd? | Link
------------- | ------------ | ----
Windows x86 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x86_fd.zip
Windows x86 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x86_sc.zip
Windows x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x64_fd.zip
Windows x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_win-x64_sc.zip
Mac OS x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_osx-x64_fd.zip
Mac OS x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_osx-x64_sc.zip
Linux x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_linux-x64_fd.zip
Linux x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.1/cp2_1.0.1_linux-x64_sc.zip
Windows x86 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_win-x86_fd.zip
Windows x86 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_win-x86_sc.zip
Windows x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_win-x64_fd.zip
Windows x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_win-x64_sc.zip
Mac OS x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_osx-x64_fd.zip
Mac OS x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_osx-x64_sc.zip
Linux x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_linux-x64_fd.zip
Linux x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.2/cp2_1.0.2_linux-x64_sc.zip

Once downloaded, unzip the file somewhere convenient (Safari on the Mac will do the unzip
for you). There is no installer; the commands are executed directly from where they are unzipped.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CiderPress II #
# CiderPress II #

CiderPress II is a software tool for working with disk images and file archives associated
with vintage Apple computers, notably the Apple II line and early Macintoshes. It runs on
Expand Down
46 changes: 46 additions & 0 deletions SourceNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,49 @@ As of v1.0, the division of code between components is approximately:

(Based on Lines of Executable Code, from Visual Studio's "Calculate Code
Metrics" feature.)

## Publishing a New Release ##

There are several steps involved in publishing a new release. Start by
updating versions and running a final set of tests on the app.

1. Update the version number in `AppCommon/GlobalAppVersion.cs`. This
changes the version number displayed by the applications, and
determines the version in the filenames generated by MakeDist.
2. Update the version number in `DiskArc/Defs.cs`. This just tracks
GlobalAppVersion. It's stored redundantly because the library is
intended to be separable from the application. (You don't need to
update this for a non-final release.)
3. Do a full build of the project in Visual Studio, in Debug mode. It's
important to build for Debug to enable assertions and extended checks.
Note this step builds MakeDist with the updated version number.
4. Launch the GUI application. Verify the version number. It's also good
to do this because, in a Debug build, some library unit tests are
executed during app startup.
5. Run the command-line tests: `cp2 debug-test`, `cp2 debug-test-da`,
and `cp2 debug-test-fc`. These require files in the TestData directory.
All tests must pass. If you're not built for Debug mode, you will see
a warning at the end of the test runs.

If this is a "final" release, you will need to publish updated documentation
as well. Don't do this for pre-releases; the web documentation should
always match the latest final release.

6. Update the `app_version` number in `ndocs/publish.py`. This is used
for text substitution in the descriptive text and installer links.
7. From the command line, in the `ndocs` directory, run `publish.py`
(you may need to explicitly run python). This will update the contents
of the `docs` directory and the top-level documentation (including
this file) with the contents of `ndocs`. Check the diffs.

Finally, build the applications and submit the changes.

8. Run `makedist build` from the top level of the source tree (it'll be in
`MakeDist/bin/debug/NET6.0`). This builds the distribution packages.
The output will be in the `DIST` directory.
9. Submit all changes to git, push them to the server.
10. Create a new release on github. Drag `DIST/*.zip` into the release.
11. Update/close any issues that have been addressed by the new release.

Version numbers should follow the semantic versioning scheme: v1.2.3,
v1.2.3-dev1, etc.
5 changes: 5 additions & 0 deletions docs/Manual-cp2.md
Original file line number Diff line number Diff line change
Expand Up @@ -1600,9 +1600,11 @@ Text documents:
- `teach`: Apple IIgs Teach Document

Graphics:
- `ashape`: Applesoft shape table
- `dhgr`: Apple II double-hi-res screen
- `conv` (multi): color conversion: `bw`, `latch`, `window`, or `simple`
(default is `latch`)
- `gsicon`: Apple IIgs Finder icon file
- `hgr`: Apple II hi-res screen
- `bw` (bool): false=color (default), true=black & white
- `hgrfont`: Apple II or /// hi-res screen font
Expand All @@ -1612,6 +1614,8 @@ Graphics:
- `mult` (bool): true=multiplies pixels 2x horiz, 3x vert (default)
- `psfont`: Print Shop font
- `mult` (bool): true=multiplies pixels 2x horiz, 3x vert (default)
- `qdfont`: Apple IIgs QuickDraw II bitmap font file
- `mode` (multi): output type: `sample`, `grid`
- `shr`: Apple IIgs super hi-res screen ($C1/0000)
- `shr3200`: Apple IIgs super hi-res 3200-color screen ($C1/0002)
- `shr3201`: Apple IIgs compressed super hi-res 3200-color screen
Expand Down Expand Up @@ -1665,6 +1669,7 @@ ignored, because the input files are expected to be host files.
The available converters are:
- `bas`: convert Applesoft BASIC listing back to a tokenized program (only
works on .txt output, not .rtf output)
- `merlin`: convert a plain text file to Merlin's ProDOS file format
- `text`: convert host text file, replacing end-of-line markers and
converting characters
- `inchar` (multi): define input (host) character set
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ handful of top-level documents (like the project README and installation
instructions) are copied out of the `top` directory.

Some text variable substitutions can be performed on HTML and Markdown files
as they are copied, e.g. all occurrences of `1.0.1` will be replaced with
as they are copied, e.g. all occurrences of `1.0.2` will be replaced with
the current app version. This is used to update the links in the download
instructions (`Install.md`) to point at the current release.

Expand Down
8 changes: 6 additions & 2 deletions docs/doc-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,15 +163,15 @@ <h3>Filesystems</h3>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/CPM-notes.md">
CP/M for Apple II 5.25" and 3.5" disks</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/DOS-notes.md">
DOS (Disk Operating System) 3.2 / 3.3</a></li>
Apple DOS (Disk Operating System) 3.2 / 3.3</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/Gutenberg-notes.md">
Gutenberg word processor filesystem</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/HFS-notes.md">
HFS (Hierarchical File System)</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/MFS-notes.md">
MFS (Macintosh File System)</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/Pascal-notes.md">
Pascal (filesystem developed for Apple Pascal)</a></li>
Pascal (filesystem developed for Apple's UCSD Pascal)</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/ProDOS-notes.md">
ProDOS (Professional Disk Operating System) and SOS (Sophisticated Operating System)</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/DiskArc/FS/RDOS-notes.md">
Expand Down Expand Up @@ -220,6 +220,10 @@ <h3>Vintage File Formats</h3>
Apple IIgs super-hi-res image (various formats, including APF and DreamGrafix)</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/FileConv/Gfx/BitmapFont-notes.md">
Apple IIgs QuickDraw II bitmap font file</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/FileConv/Gfx/GSFinderIcon-notes.md">
Apple IIgs Finder icon file</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/FileConv/Gfx/ShapeTable-notes.md">
Applesoft shape table</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/FileConv/Gfx/MacPaint-notes.md">
MacPaint graphics document</a></li>
<li><a href="https://github.com/fadden/CiderPress2/blob/main/FileConv/Gfx/PrintShop-notes.md">
Expand Down
10 changes: 7 additions & 3 deletions docs/features.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,12 +213,15 @@ <h4>File Conversion - Export</h4>
<tr> <td>Teach Document</td> <td>most formatting supported</td> </tr>
<tr> <td>Apple II hi-res</td> <td>560x384 color or B&amp;W bitmap, with half-pixel shifts</td> </tr>
<tr> <td>Apple II &amp; Apple /// hi-res font</td> <td>bitmap grid with 96 or 128 glyphs</td> </tr>
<tr> <td>Applesoft shape table</td> <td>bitmap grid</td> </tr>
<tr> <td>LZ4FH hi-res</td> <td>560x384 color or B&amp;W</td> </tr>
<tr> <td>Apple II double hi-res</td> <td>560x384 color or B&amp;W</td> </tr>
<tr> <td>Apple IIgs super hi-res</td> <td>640x400 color; unpacked ($C1/0000),
Paintworks ($C0/0000), packed ($C0/0001), APF ($C0/0002)</td> </tr>
<tr> <td>Apple IIgs super hi-res 3200</td> <td>640x400 color; unpacked ($C1/0002),
DreamGrafix ($C0/8005), ".3201"</td> </tr>
<tr> <td>Apple IIgs bitmap font</td> <td>bitmap with rendered sample or a glyph grid</td> </tr>
<tr> <td>Apple IIgs Finder icon file</td> <td>bitmap grid with large/small icons and masks</td> </tr>
<tr> <td>MacPaint</td> <td>576x720 B&amp;W</td> </tr>
<tr> <td>Print Shop / GS clip art</td> <td>color and monochrome</td> </tr>
<tr> <td>Print Shop font</td> <td>bitmap</td> </tr>
Expand All @@ -238,11 +241,12 @@ <h4>File Conversion - Import</h4>
<th>Action</th>
</tr>
<tr> <td>Plain text</td> <td>convert EOL and character set</td> </tr>
<tr> <td>Applesoft BASIC</td> <td>plain text to executable form</td> </tr>
<tr> <td>Merlin Assembler</td> <td>convert plain text to Merlin's ProDOS file format</td> </tr>
<tr> <td>Applesoft BASIC</td> <td>convert plain text to executable form</td> </tr>
</table>

<p>Imported text files may be encoded with UTF-8, ISO 8859-1, or CP 1252.
They can be converted to ASCII, high ASCII, or Mac OS Roman.</p>
<p>For plain text conversions, imported text files may be encoded with
UTF-8, ISO 8859-1, or CP 1252. They can be converted to ASCII, high ASCII, or Mac OS Roman.</p>

</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h4>Key features:</h4>

<p>
<a href="https://github.com/fadden/CiderPress2/releases/latest">
<b>Download</b> the latest release (1.0.1)</a> from github.</p>
<b>Download</b> the latest release (1.0.2)</a> from github.</p>

<h4>Free Software</h4>
<p>The full source code for CiderPress II is available on
Expand Down
2 changes: 1 addition & 1 deletion ndocs/publish.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


# Current version string. Used for text substitution.
app_version = "1.0.1"
app_version = "1.0.2"
pkg_version = app_version

# ----- nothing configurable below -----
Expand Down
25 changes: 13 additions & 12 deletions ndocs/top/SourceNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,39 +124,40 @@ updating versions and running a final set of tests on the app.
1. Update the version number in `AppCommon/GlobalAppVersion.cs`. This
changes the version number displayed by the applications, and
determines the version in the filenames generated by MakeDist.
1. Update the version number in `DiskArc/Defs.cs`. This just tracks
2. Update the version number in `DiskArc/Defs.cs`. This just tracks
GlobalAppVersion. It's stored redundantly because the library is
intended to be separable from the application. (You don't need to
update this for a non-final release.)
1. Do a full build of the project in Visual Studio, in Debug mode. It's
3. Do a full build of the project in Visual Studio, in Debug mode. It's
important to build for Debug to enable assertions and extended checks.
Note this step builds MakeDist with the updated version number.
1. Launch the GUI application. Verify the version number. It's also good
4. Launch the GUI application. Verify the version number. It's also good
to do this because, in a Debug build, some library unit tests are
executed during app startup.
1. Run the command-line tests: `cp2 debug-test`, `cp2 debug-test-da`,
and `cp2 debug-test-fc`. All tests must pass. If you're not built for
Debug mode, you will see a warning at the end of the test runs.
5. Run the command-line tests: `cp2 debug-test`, `cp2 debug-test-da`,
and `cp2 debug-test-fc`. These require files in the TestData directory.
All tests must pass. If you're not built for Debug mode, you will see
a warning at the end of the test runs.

If this is a "final" release, you will need to publish updated documentation
as well. Don't do this for pre-releases; the web documentation should
always match the latest final release.

1. Update the `app_version` number in `ndocs/publish.py`. This is used
6. Update the `app_version` number in `ndocs/publish.py`. This is used
for text substitution in the descriptive text and installer links.
1. From the command line, in the `ndocs` directory, run `publish.py`
7. From the command line, in the `ndocs` directory, run `publish.py`
(you may need to explicitly run python). This will update the contents
of the `docs` directory and the top-level documentation (including
this file) with the contents of `ndocs`. Check the diffs.

Finally, build the applications and submit the changes.

1. Run `makedist build` from the top level of the source tree (it'll be in
8. Run `makedist build` from the top level of the source tree (it'll be in
`MakeDist/bin/debug/NET6.0`). This builds the distribution packages.
The output will be in the `DIST` directory.
1. Submit all changes to git, push them to the server.
1. Create a new release on github. Drag `DIST/*.zip` into the release.
1. Update/close any issues that have been addressed by the new release.
9. Submit all changes to git, push them to the server.
10. Create a new release on github. Drag `DIST/*.zip` into the release.
11. Update/close any issues that have been addressed by the new release.

Version numbers should follow the semantic versioning scheme: v1.2.3,
v1.2.3-dev1, etc.

0 comments on commit 52a7ac9

Please sign in to comment.