Skip to content

Commit af41d2f

Browse files
authored
Update deploy notes. (#500)
1 parent 2a21d09 commit af41d2f

4 files changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,16 @@ Arduino library for the Open Acidification pH Stat Controller
1616

1717
* Use [`extras/scripts/install.sh`](extras/scripts/install.sh) to do the initial install.
1818
* After that use [`extras/scripts/testAndBuild.sh`](extras/scripts/testAndBuild.sh) to test.
19-
* See [this video](https://youtu.be/ZYNnVE4LnCg) for an install and test example.
20-
* Push a tag with 'v' in order to build a release
21-
* Use Ansible to install on [oap.cs.wallawalla.edu](oap.cs.wallawalla.edu).
19+
* See [this video](https://youtu.be/ZYNnVE4LnCg) for an install and test example.
20+
* Release Process
21+
* Update the version files to a new version (e.g., v25.4.1)
22+
* Create a _local_ tag on the _previous_ commit
23+
* Commit _only_ the version files to avoid edits to the version files (see `extras/scripts/pre-commit`)
24+
* Push and merge the commit
25+
* Fetch and move the local main to upstream main
26+
* Move the tag to the merged commit with the version file changes
27+
* Push the tag to origin and upstream
28+
* Use Ansible to install on [oap.cs.wallawalla.edu](oap.cs.wallawalla.edu).
2229
* To build the GUI simulator, see [GUI/build.sh](GUI/build.sh).
2330
* Use the [`extras/scripts/tasks.json`](extras/scripts/tasks.json) file to easily start the development servers in Visual Studio Code.
2431
* Copy the JSON file to your [`.vscode`](.vscode) directory
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
const String gitVersion = 'v25.4.1 ';
1+
const String gitVersion = 'v25.4.1 +';

extras/scripts/pre-commit

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
# Create a tag before committing and then move the tag to the commit (yes, a bit of a hack!)
12
version=`git describe --tags`
23
version="$version "
4+
# if the only change is in Version.h or version.dart, don't add the + to the version
35
changes=`git diff --name-only --cached | grep -v "Version.h" | grep -v "version.dart" | wc -l | xargs`
46
if [[ "$changes" == "0" ]]
57
then

src/Version.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
#define VERSION "v25.4.1 "
1+
#define VERSION "v25.4.1 +"

0 commit comments

Comments
 (0)