Skip to content

Update deploy instructions #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update deploy instructions #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,16 @@ Arduino library for the Open Acidification pH Stat Controller

* Use [`extras/scripts/install.sh`](extras/scripts/install.sh) to do the initial install.
* After that use [`extras/scripts/testAndBuild.sh`](extras/scripts/testAndBuild.sh) to test.
* See [this video](https://youtu.be/ZYNnVE4LnCg) for an install and test example.
* Push a tag with 'v' in order to build a release
* Use Ansible to install on [oap.cs.wallawalla.edu](oap.cs.wallawalla.edu).
* See [this video](https://youtu.be/ZYNnVE4LnCg) for an install and test example.
* Release Process
* Update the version files to a new version (e.g., v25.4.1)
* Create a _local_ tag on the _previous_ commit
* Commit _only_ the version files to avoid edits to the version files (see `extras/scripts/pre-commit`)
* Push and merge the commit
* Fetch and move the local main to upstream main
* Move the tag to the merged commit with the version file changes
* Push the tag to origin and upstream
* Use Ansible to install on [oap.cs.wallawalla.edu](oap.cs.wallawalla.edu).
* To build the GUI simulator, see [GUI/build.sh](GUI/build.sh).
* Use the [`extras/scripts/tasks.json`](extras/scripts/tasks.json) file to easily start the development servers in Visual Studio Code.
* Copy the JSON file to your [`.vscode`](.vscode) directory
Expand Down
2 changes: 1 addition & 1 deletion extras/device_client/lib/model/version.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
const String gitVersion = 'v25.4.1 ';
const String gitVersion = 'v25.4.1 +';
2 changes: 2 additions & 0 deletions extras/scripts/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Create a tag before committing and then move the tag to the commit (yes, a bit of a hack!)
version=`git describe --tags`
version="$version "
# if the only change is in Version.h or version.dart, don't add the + to the version
changes=`git diff --name-only --cached | grep -v "Version.h" | grep -v "version.dart" | wc -l | xargs`
if [[ "$changes" == "0" ]]
then
Expand Down
2 changes: 1 addition & 1 deletion src/Version.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
#define VERSION "v25.4.1 "
#define VERSION "v25.4.1 +"
Copy link
Preview

Copilot AI Apr 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version string includes an unexpected '+' character at the end which could lead to inconsistency with the documented version format. If this is unintentional, please remove the '+' for clarity and consistency.

Suggested change
#define VERSION "v25.4.1 +"
#define VERSION "v25.4.1"

Copilot uses AI. Check for mistakes.