Dev Knowledge Base Nektos-ACT Documentation fixes issue #723 #730

JustKuzya · 2025-01-30T18:32:58Z

Fixes issue #723

JustKuzya · 2025-02-13T22:40:10Z

The latest changes should fix #731 as well

keithmanville · 2025-02-14T15:35:25Z

I tried following the instructions and created my-env1.cfg with the following contents:

### Env Variable for GitHub Branch
DIOPTRA_BRANCH=dev
### Env Variable for Deployment Path
DIOPTRA_DEPLOY=~/dev/dioptra-deploy
### Env Variable for Source Path
DIOPTRA_CODE=~/dev/dioptra

Then ran source ./dev-env+.sh -e ./my-env1.cfg

I'm using zsh, so the first thing I encountered was:

❌❌❌ BASH is required to run this script ❌❌❌

I opened a bash shell and tried again and got:

Number of arguments: 2
Argument 0: bash
Argument 1: -e

 -e - ./my-env1.cfgReading config file: ./my-env1.cfg
bash: ${key^^}: bad substitution


❌❌❌ !!!Failed to set up environment configuration!!! ❌❌❌


The following Parameters were expected:
DIOPTRA_BRANCH=
DIOPTRA_DEPLOY=
DIOPTRA_CODE=
DIOPTRA_ENV_FILE=./my-env1.cfg
You can use 'env | sort' or 'printenv' command to view the rest of the environment variables

I noticed the run-X.sh scripts use #!/opt/homebrew/bin/bash which is mac and configuration specific. Since I don't have this on my system running these scripts fails.

I thought this was to set up a development environment, so needing to specify a deploy location was confusing to me.

I was able to get things working with the dev-env.sh script after modifying the config variables. But now I need to edit a file tracked by git to get my dev setup going.

The way I've been working locally is to have an env file that I source before running any of the dioptra services. These are the main items I found I needed to configure and I found having everything in a single env file for editing to be more straightforward.

export DIOPTRA_RESTAPI_DEV_DATABASE_URI="sqlite:////Users/kmanville/dev/dioptra/dioptra-dev.db"
export DIOPTRA_RESTAPI_ENV=dev
export DIOPTRA_WORKER_USERNAME="dioptra-worker"
export DIOPTRA_WORKER_PASSWORD="password"
export DIOPTRA_API="http://localhost:5173"
export RQ_REDIS_URI="redis://localhost:6379/0"
export MLFLOW_S3_ENDPOINT_URL="http://localhost:35000"
export MLFLOW_TRACKING_URI="http://localhost:35000"
export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES

How should we guide developers between the existing DEVELOPER.md and these knowledge base docs and scripts?

JustKuzya · 2025-02-14T15:40:50Z

Yep – it won’t work in zsh ☹ I could add logic to work in ZSH if that’s required. But bash 5+ is the requirement, I thought. DC From: Keith Manville ***@***.***> Date: Friday, February 14, 2025 at 10:35 AM To: usnistgov/dioptra ***@***.***> Cc: Cousin, Dmitry A. (Fed) ***@***.***>, Author ***@***.***> Subject: Re: [usnistgov/dioptra] Dev Knowledge Base Nektos-ACT Documentation fixes issue #723 (PR #730) I tried following the instructions and created my-env1.cfg with the following contents: ### Env Variable for GitHub Branch DIOPTRA_BRANCH=dev ### Env Variable for Deployment Path DIOPTRA_DEPLOY=~/dev/dioptra-deploy ### Env Variable for Source Path DIOPTRA_CODE=~/dev/dioptra Then ran source ./dev-env+.sh -e ./my-env1.cfg I'm using zsh, so the first thing I encountered was: ❌❌❌ BASH is required to run this script ❌❌❌ I opened a bash shell and tried again and got: Number of arguments: 2 Argument 0: bash Argument 1: -e -e - ./my-env1.cfgReading config file: ./my-env1.cfg bash: ${key^^}: bad substitution ❌❌❌ !!!Failed to set up environment configuration!!! ❌❌❌ The following Parameters were expected: DIOPTRA_BRANCH= DIOPTRA_DEPLOY= DIOPTRA_CODE= DIOPTRA_ENV_FILE=./my-env1.cfg You can use 'env | sort' or 'printenv' command to view the rest of the environment variables I noticed the run-X.sh scripts use #!/opt/homebrew/bin/bash which is mac and configuration specific. Since I don't have this on my system running these scripts fails. I thought this was to set up a development environment, so needing to specify a deploy location was confusing to me. I was able to get things working with the dev-env.sh script after modifying the config variables. But now I need to edit a file tracked by git to get my dev setup going. The way I've been working locally is to have an env file that I source before running any of the dioptra services. These are the main items I found I needed to configure and I found having everything in a single env file for editing to be more straightforward. export DIOPTRA_RESTAPI_DEV_DATABASE_URI="sqlite:////Users/kmanville/dev/dioptra/dioptra-dev.db" export DIOPTRA_RESTAPI_ENV=dev export DIOPTRA_WORKER_USERNAME="dioptra-worker" export DIOPTRA_WORKER_PASSWORD="password" export DIOPTRA_API="http://localhost:5173" export RQ_REDIS_URI="redis://localhost:6379/0" export MLFLOW_S3_ENDPOINT_URL="http://localhost:35000" export MLFLOW_TRACKING_URI="http://localhost:35000" export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES How should we guide developers between the existing DEVELOPER.md<https://github.com/usnistgov/dioptra/blob/main/DEVELOPER.md> and these knowledge base docs and scripts? — Reply to this email directly, view it on GitHub<#730 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACS6IVTRZ62IH3HL7OM7AHD2PYENJAVCNFSM6AAAAABWF45V46VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNJZGY2DMMBXGA>. You are receiving this because you authored the thread.Message ID: ***@***.***> [keithmanville]keithmanville left a comment (usnistgov/dioptra#730)<#730 (comment)> I tried following the instructions and created my-env1.cfg with the following contents: ### Env Variable for GitHub Branch DIOPTRA_BRANCH=dev ### Env Variable for Deployment Path DIOPTRA_DEPLOY=~/dev/dioptra-deploy ### Env Variable for Source Path DIOPTRA_CODE=~/dev/dioptra Then ran source ./dev-env+.sh -e ./my-env1.cfg I'm using zsh, so the first thing I encountered was: ❌❌❌ BASH is required to run this script ❌❌❌ I opened a bash shell and tried again and got: Number of arguments: 2 Argument 0: bash Argument 1: -e -e - ./my-env1.cfgReading config file: ./my-env1.cfg bash: ${key^^}: bad substitution ❌❌❌ !!!Failed to set up environment configuration!!! ❌❌❌ The following Parameters were expected: DIOPTRA_BRANCH= DIOPTRA_DEPLOY= DIOPTRA_CODE= DIOPTRA_ENV_FILE=./my-env1.cfg You can use 'env | sort' or 'printenv' command to view the rest of the environment variables I noticed the run-X.sh scripts use #!/opt/homebrew/bin/bash which is mac and configuration specific. Since I don't have this on my system running these scripts fails. I thought this was to set up a development environment, so needing to specify a deploy location was confusing to me. I was able to get things working with the dev-env.sh script after modifying the config variables. But now I need to edit a file tracked by git to get my dev setup going. The way I've been working locally is to have an env file that I source before running any of the dioptra services. These are the main items I found I needed to configure and I found having everything in a single env file for editing to be more straightforward. export DIOPTRA_RESTAPI_DEV_DATABASE_URI="sqlite:////Users/kmanville/dev/dioptra/dioptra-dev.db" export DIOPTRA_RESTAPI_ENV=dev export DIOPTRA_WORKER_USERNAME="dioptra-worker" export DIOPTRA_WORKER_PASSWORD="password" export DIOPTRA_API="http://localhost:5173" export RQ_REDIS_URI="redis://localhost:6379/0" export MLFLOW_S3_ENDPOINT_URL="http://localhost:35000" export MLFLOW_TRACKING_URI="http://localhost:35000" export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES How should we guide developers between the existing DEVELOPER.md<https://github.com/usnistgov/dioptra/blob/main/DEVELOPER.md> and these knowledge base docs and scripts? — Reply to this email directly, view it on GitHub<#730 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACS6IVTRZ62IH3HL7OM7AHD2PYENJAVCNFSM6AAAAABWF45V46VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNJZGY2DMMBXGA>. You are receiving this because you authored the thread.Message ID: ***@***.***>

hbooth

please make changes as needed

hbooth · 2025-02-20T14:07:50Z

dev-kb/local-setup/dev-env+.sh

@@ -0,0 +1,206 @@
+#!/opt/homebrew/bin/bash


this won't work on all systems does /bin/bash work for macs?

yes, /bin/bash exists on mac and works for me. I think the more robust shebang is #!/usr/bin/env bash which should find bash as long as it's in your path somewhere.

hbooth · 2025-02-20T14:10:20Z

dev-kb/local-setup/README.md

+    git_branch=dev
+    dir_work=~/dio/dio2-wrk
+    dir_source=~/dio/dio2-src
+    ```


Why have alternative names? I think having just one way of doing this will make it easier to support the scripts over time as well debug when problems arise.

hbooth · 2025-02-20T14:11:51Z

dev-kb/local-setup/README.md

+
+   3. #### In the shell environment sourced in the steps 1 and 2 or only 2, run the setup script:
+    ```
+    ./stup.sh


dev-kb/local-setup/dev-env.sh

hbooth · 2025-02-20T14:16:05Z

dev-kb/local-setup/env-example1.cfg

this seems unnecessary given this example exists in the README.md. Would prefer to only have one place where this exists to avoid things getting out of synch.

hbooth · 2025-02-20T14:21:22Z

docs/source/overview/executive-summary.rst

this change should not be here. looks like you need pull/update PR

hbooth · 2025-02-20T14:52:18Z

dev-kb/nektos-act/README.md

+## <a id="act-verify"> To verify success of the ACT installation you can run any of the following commands</a>:
+ - ### <a id="act-version">List current ACT version</a>:
+```sh
+act --version


on linux it installs into

`pwd`/bin/act

so command to run would be something like ./bin/act --version

i suggest adding something to add act to path or create a soft ln to act from directory already in path (I did the latter)

hbooth · 2025-02-20T14:53:42Z

dev-kb/nektos-act/README.md

@@ -0,0 +1,123 @@
+# Nektos-ACT Use Guide
+### This guide describes necessary steps to use of Nektos-ACT for developing, debugging, and running github actions locally
+


need a note somewhere around here to remind that docker is necessary to be installed and the docker service running

dev-kb/nektos-act/README.md

hbooth · 2025-02-20T15:00:26Z

dev-kb/nektos-act/README.md

+export DOCKER_CERT_PATH=$(docker context inspect --format '{{.Storage.TLSPath}}')/docker
+```  
+
+<!--


is this still needed? seems redundant to earlier

This is just in case certificates are desired or a dev machine has strong security access policy for container(s)

JustKuzya added 5 commits January 27, 2025 09:21

feat: add Nektos/ACT use to knowledge base

0556ad6

fix: fix unintelligeable wording

a3ee85b

fix: correct typo in docs content

31e4887

feat: aded nektos-act guide and create dev-kb directory

43a0dcc

fix: corrected subtitle

bf2b4e3

JustKuzya changed the title ~~Dev Knowledge Base Nektos-ACT Documentation fixes issue #724~~ Dev Knowledge Base Nektos-ACT Documentation fixes issue #723 Jan 30, 2025

keithmanville linked an issue Feb 6, 2025 that may be closed by this pull request

Create Developer Knowledge Base and add Description of Nektos-ACT #723

Open

keithmanville requested a review from hbooth February 6, 2025 18:42

feat: add dev-setup scripts and instructions

89a6c77

Merge branch 'dev' into jk-dev-kb

4134003

hbooth requested changes Feb 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dev Knowledge Base Nektos-ACT Documentation fixes issue #723 #730

Dev Knowledge Base Nektos-ACT Documentation fixes issue #723 #730

JustKuzya commented Jan 30, 2025 •

edited

Loading

JustKuzya commented Feb 13, 2025

keithmanville commented Feb 14, 2025

JustKuzya commented Feb 14, 2025 via email

hbooth left a comment

hbooth Feb 20, 2025

keithmanville Feb 20, 2025

hbooth Feb 20, 2025 •

edited

Loading

hbooth Feb 20, 2025

hbooth Feb 20, 2025

hbooth Feb 20, 2025

hbooth Feb 20, 2025

hbooth Feb 20, 2025

hbooth Feb 20, 2025

hbooth Feb 20, 2025

JustKuzya Feb 20, 2025

		@@ -0,0 +1,123 @@
		# Nektos-ACT Use Guide
		### This guide describes necessary steps to use of Nektos-ACT for developing, debugging, and running github actions locally

Dev Knowledge Base Nektos-ACT Documentation fixes issue #723 #730

Are you sure you want to change the base?

Dev Knowledge Base Nektos-ACT Documentation fixes issue #723 #730

Conversation

JustKuzya commented Jan 30, 2025 • edited Loading

JustKuzya commented Feb 13, 2025

keithmanville commented Feb 14, 2025

JustKuzya commented Feb 14, 2025 via email

hbooth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hbooth Feb 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JustKuzya commented Jan 30, 2025 •

edited

Loading

hbooth Feb 20, 2025 •

edited

Loading