Dev

.github/workflows/test.yml

@@ -0,0 +1,59 @@
+---
+name: ci
+
+'on':
+  push:
+    branches:
+      - '**'
+
+permissions:
+  contents: write
+
+jobs:
+  ci:
+    runs-on: [self-hosted, dev]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Extras / Count Lines of Source Code
+        run: make extras/cloc
+
+      # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+      # Lint
+      # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+      - name: Lint
+        run: make format
+
+      - name: Check
+        run: git diff HEAD --quiet
+
+      # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+      # Build [Prod] (and Upload binary)
+      # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+      - name: Check release version
+        id: check-release-version
+        if: github.ref == 'refs/heads/master'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          RELEASE_TAG=$(make deploy/get-current-db-version)
+          # Test that github-cli is working
+          gh --version
+          gh release list -L 1
+          # TODO: enhance this to be: if release_tag > current_prod_tag, deploy.
+          #       Otherwise, can skip this step entirely?
+          gh release view $RELEASE_TAG || echo "PUBLISH=1" >> "$GITHUB_OUTPUT"
+
+      # yamllint disable rule:line-length
+      - name: Build (production release)
+        if: github.ref == 'refs/heads/master' && steps.check-release-version.outputs.PUBLISH
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: set -o pipefail; make build
+
+      - name: Upload artifacts (production release)
+        if: github.ref == 'refs/heads/master' && steps.check-release-version.outputs.PUBLISH
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: set -o pipefail; make deploy/upload

Makefile

@@ -0,0 +1,97 @@
+SHELL=/bin/bash
+
+.DEFAULT_GOAL := _help
+
+# NOTE: must put a <TAB> character and two pound "\t##" to show up in this list.  Keep it brief! IGNORE_ME
+.PHONY: _help
+_help:
+	@grep -h "##" $(MAKEFILE_LIST) | grep -v IGNORE_ME | grep -v ^# | sed -e 's/##//' | column -t -s $$'\t'
+
+
+
+# ---------------------------------------
+# Format
+# ---------------------------------------
+
+.PHONY: format
+format:	## format SQL with pg_format
+	# TODO: what about import.sql?  It gets formatted too ugly
+	# TODO: what about Python files?
+	pg_format -L -s 2 -w 100 sql/tables.sql >sql/tables.fmt.sql
+	mv sql/tables.fmt.sql sql/tables.sql
+
+
+
+# ---------------------------------------
+# Build, test, and docs
+# ---------------------------------------
+
+DB_VERSION ?= $(shell python3 sql/latest_version.py)
+DB_FILE ?= sql/usda.sqlite3
+DB_XZ_FILE ?= sql/dist/usda.sqlite3-${DB_VERSION}.tar.xz
+
+.PHONY: build
+build: clean
+build:	## Build the release (compressed XZ file)
+	test "${DB_VERSION}"
+	./sql/build.sh ${DB_VERSION}
+	du -h ${DB_XZ_FILE}
+
+.PHONY: test
+test:	## Test the SQL database with basic queries
+	test -f ${DB_FILE}
+	sqlite3 ${DB_FILE} ".tables"
+	sqlite3 ${DB_FILE} "\
+	  SELECT * FROM nutr_def WHERE id=328; \
+	  SELECT long_desc FROM food_des WHERE id=9050; \
+	  SELECT * FROM version; \
+	"
+
+.PHONY: docs
+docs:	## Build the relational SVG diagram
+	./docs/sqleton.sh
+
+
+
+# ---------------------------------------
+# Deploy
+# ---------------------------------------
+
+.PHONY: deploy/get-current-db-version
+deploy/get-current-db-version:
+	@test "${DB_VERSION}"
+	@echo v${DB_VERSION}
+
+
+.PHONY: deploy/upload
+deploy/upload:	## Upload to GitHub releases
+	test -n "${DB_VERSION}"
+	test -f ${DB_XZ_FILE}
+	gh release create v${DB_VERSION} --generate-notes
+	gh release upload v${DB_VERSION} ${DB_XZ_FILE}
+
+.PHONY: deploy/delete
+deploy/delete:
+	[[ "$(shell read -e -p 'Really delete v${DB_VERSION}? [y/N]> '; echo $$REPLY)" == [Yy]* ]]
+	gh release delete v${DB_VERSION}
+	git push origin --delete v${DB_VERSION}
+	- git tag -d v${DB_VERSION}
+
+
+
+# ---------------------------------------
+# Clean & extras
+# ---------------------------------------
+
+.PHONY: clean
+clean:	## Clean up leftover bits and stuff from build
+	rm -f sql/*.sqlite
+	rm -f sql/*.sqlite3
+
+.PHONY: check-vars
+check-vars:	## display all computed vars (won't show passed in)
+	$(foreach v, $(.VARIABLES), $(if $(filter file, $(origin $(v))), $(info $(v)=$($(v)))))
+
+.PHONY: extras/cloc
+extras/cloc:	## count lines of code
+	cloc HEAD --exclude-dir=usda.svg

README.rst

@@ -1,9 +1,9 @@
-***********
+*************
  usda-sqlite
-***********
+*************
 
-.. image:: https://api.travis-ci.com/nutratech/usda-sqlite.svg?branch=master
-    :target: https://travis-ci.com/github/nutratech/usda-sqlite
+.. image:: https://github.com/nutratech/usda-sqlite/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/nutratech/usda-sqlite/actions/workflows/test.yml
 
 Python, SQL and CSV files for setting up portable usda-sqlite database.
 
@@ -12,6 +12,7 @@ See CLI:        https://github.com/nutratech/cli
 See nt-sqlite:  https://github.com/nutratech/nt-sqlite
 
 
+
 Building the database
 #########################
 
@@ -30,7 +31,9 @@ Building the database
     bash setup.sh
     python3 process.py
 
-3. If you are committing database changes, add a line to :code:`sql/version.csv` (e.g. :code:`id=3` is the latest in this case),
+
+3. If you are committing database changes, add a line to
+   :code:`sql/version.csv` (e.g. :code:`id=3` is the latest in this case).
 
 +-----+----------+-----------------------------------+
 | id  | version  | created                           |
@@ -42,33 +45,36 @@ Building the database
 | 3   | 0.0.2    | Thu 06 Aug 2020 09:21:39 AM EDT   |
 +-----+----------+-----------------------------------+
 
-4. i. (Optional) Enforce foreign keys with your ``~/.sqliterc`` file,
 
-::
+4. i. *(Optional)* Enforce FKs by copying this to your ``~/.sqliterc`` file.
+
+.. code-block:: text
 
     .headers on
     .mode column
     PRAGMA foreign_keys = 1;
 
-4. ii. Create the database with
+4. ii. Create the database.
 
 .. code-block:: bash
 
-    cd ../sql
-    ./build.sh X.X.X  # e.g. 0.0.8
+  make build
 
 
-5. Verify the tables (again inside the SQL shell :code:`sqlite3 usda.sqlite3`),
+5. Verify the tables.
 
 .. code-block:: sql
 
-    .tables
-    SELECT * FROM nutr_def WHERE id=328;
-    SELECT long_desc FROM food_des WHERE id=9050;
-    SELECT * FROM version;
-    .exit
+  make test
+
+
+6. If everything looks good, upload compressed
+   :code:`dist/nutra-X.X.X.db.tar.xz` file to binary host.
+
+.. code-block:: bash
+
+  make deploy/upload
 
-6. If everything looks good, upload compressed :code:`dist/nutra-X.X.X.db.tar.xz` file to binary host (bitbucket files).
 
 
 Tables (Relational Design)