Add nix flake #27

jasonodoom · 2023-08-23T16:08:54Z

🗣 Description

This PR adds flake.nix to allow for the use of awssh without the following:

Requiring Python to be installed on the host system
Executing setup-env script to install awssh
Managing, starting or maintaining virtual environments for Python

This does not require or use poetry

💭 Motivation and context

The motivation and purpose of this is to provide access to our tools quickly. Considering the recent re-provisioning of my machine I find it convenient to simply run. nix build so I can execute awssh without having to configure virtualenvs or making other system changes. This is just the beginning.

🧪 Testing

The binary was executed and I was able to successfully start a session as well as execute different awssh options. I've included a screenshot.

✅ Pre-approval checklist

This PR has an informative and human-readable title.
Changes are limited to a single goal - eschew scope creep!
All relevant type-of-change labels have been added.
I have read the CONTRIBUTING document.
These code changes follow cisagov code standards.
All relevant repo and/or project documentation has been updated to reflect the changes in this PR.

jsf9k

The formatting on the flake file needs to be cleaned up a bit.

flake.nix

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov> Remove whitespace Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov> Sort pakages alphabetically Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov> Add pre-commit file changes

dav3r · 2023-08-23T17:32:17Z

@jasonodoom Please complete the "Testing" section of the PR description and explain how you tested these changes and verified that they do not negatively impact existing functionality.

dav3r

Please take a look at my suggestions, comments, and question.

flake.nix

dav3r · 2023-08-23T18:03:21Z

FYI, I saw that you removed the pre- and post-merge checklists from the PR template. I added them back in, since this change is worthy of a minor version bump. Please make sure that you take care of that.

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>

README.md

mcdonnnj · 2023-08-23T18:47:40Z

FYI, I saw that you removed the pre- and post-merge checklists from the PR template. I added them back in, since this change is worthy of a minor version bump. Please make sure that you take care of that.

@dav3r Is it though? This PR does not touch the Python code so I'm not sure it should require any version modifications. We do not increment for pre-commit changes for example.

mcdonnnj

Given that @jasonodoom is the only one currently invested in the Nix ecosystem I think the CODEOWNERS should be updated such that the Nix paths require review from him.

dav3r · 2023-08-23T18:51:24Z

FYI, I saw that you removed the pre- and post-merge checklists from the PR template. I added them back in, since this change is worthy of a minor version bump. Please make sure that you take care of that.

@dav3r Is it though? This PR does not touch the Python code so I'm not sure it should require any version modifications. We do not increment for pre-commit changes for example.

Gah, you are correct! I was thinking of this as a new feature, but it's just a new installation mechanism. I went ahead and removed those checklists.

jsf9k

One more tiny change request.

README.md

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

bump_version.sh

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

The pre-commit linter has not yet been added in this branch, but it will eventually be added when cisagov/skeleton-generic#143 trickles down via Lineage.

bump_version.sh

Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

dav3r

Solid work @jasonodoom! 🚀

jsf9k · 2023-09-07T19:21:35Z

I hate to bring this up so late, but I just noticed that Nix flakes files are experimental. I'm still OK with this PR going forward, but I figured folks should know.

README.md

bump_version.sh

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

mcdonnnj

LGTM ✔

jasonodoom added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Aug 23, 2023

jasonodoom requested review from dav3r, felddy, jsf9k and mcdonnnj as code owners August 23, 2023 16:08

jasonodoom force-pushed the add-nix-flake branch from 94d3412 to da668f7 Compare August 23, 2023 16:10

Add nix flake

2f97978

jasonodoom force-pushed the add-nix-flake branch from da668f7 to 2f97978 Compare August 23, 2023 16:12

jsf9k requested changes Aug 23, 2023

View reviewed changes

flake.nix Outdated Show resolved Hide resolved

flake.nix Outdated Show resolved Hide resolved

flake.nix Outdated Show resolved Hide resolved

flake.nix Outdated Show resolved Hide resolved

Sort packages aplhabetically

606e603

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

jasonodoom requested a review from jsf9k August 23, 2023 16:27

jasonodoom force-pushed the add-nix-flake branch 2 times, most recently from e98fcca to 63e41d7 Compare August 23, 2023 16:45

jasonodoom force-pushed the add-nix-flake branch from 63e41d7 to 49f99eb Compare August 23, 2023 16:50

dav3r requested changes Aug 23, 2023

View reviewed changes

flake.nix Outdated Show resolved Hide resolved

flake.nix Outdated Show resolved Hide resolved

flake.nix Show resolved Hide resolved

flake.nix Outdated Show resolved Hide resolved

Update README to add Nix instructions

9c1dd21

jasonodoom force-pushed the add-nix-flake branch from 9e08c07 to 9c1dd21 Compare August 23, 2023 18:04

Update flake description to reflect current SSM name

8441c22

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>

dav3r requested changes Aug 23, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

mcdonnnj requested changes Aug 23, 2023

View reviewed changes

jsf9k requested changes Aug 23, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

jasonodoom and others added 4 commits August 24, 2023 10:13

Modify flake to build on all platforms

8bdf314

Remove extraneous word

5eaf732

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>

Update README to simplify explanation

2fb1800

Co-authored-by: dav3r <david.redmin@trio.dhs.gov>

Fix markdown syntax

c835660

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

jasonodoom requested review from dav3r and jsf9k September 5, 2023 19:32

jsf9k requested changes Sep 5, 2023

View reviewed changes

bump_version.sh Outdated Show resolved Hide resolved

bump_version.sh Outdated Show resolved Hide resolved

jasonodoom added 2 commits September 5, 2023 15:54

Add temp file for flake version update

a86f0f5

Add git add files on one line

0ab4742

jasonodoom requested a review from jsf9k September 5, 2023 19:56

jsf9k requested changes Sep 5, 2023

View reviewed changes

bump_version.sh Outdated Show resolved Hide resolved

Fix tmp file flake var name

54df713

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

jsf9k approved these changes Sep 5, 2023

View reviewed changes

Update Nix flake formatting to pass pre-commit linter

5662fa2

The pre-commit linter has not yet been added in this branch, but it will eventually be added when cisagov/skeleton-generic#143 trickles down via Lineage.

jsf9k assigned jasonodoom Sep 6, 2023

jasonodoom added the kraken 🐙 This pull request is ready to merge during the next Lineage Kraken release label Sep 6, 2023

jsf9k removed the kraken 🐙 This pull request is ready to merge during the next Lineage Kraken release label Sep 6, 2023

dav3r reviewed Sep 6, 2023

View reviewed changes

bump_version.sh Show resolved Hide resolved

jasonodoom and others added 2 commits September 6, 2023 11:13

Add comment regarding nix installation

0344330

Mention that bump_version.sh requires Nix in README

5f791db

Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

jsf9k requested a review from dav3r September 6, 2023 15:27

dav3r approved these changes Sep 6, 2023

View reviewed changes

Merge branch 'develop' into add-nix-flake

11f1505

mcdonnnj reviewed Sep 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

jasonodoom added 2 commits September 8, 2023 15:41

Add sed logic to finalize for flake version update

782d54f

Move special development pre-req under Contributing

f831689

mcdonnnj reviewed Sep 8, 2023

View reviewed changes

bump_version.sh Outdated Show resolved Hide resolved

jasonodoom requested a review from mcdonnnj September 8, 2023 19:52

Remove FLAKE_LOCK_FILE var

adab206

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

mcdonnnj approved these changes Sep 8, 2023

View reviewed changes

jasonodoom merged commit 62d6cd1 into develop Sep 8, 2023
31 checks passed

jasonodoom deleted the add-nix-flake branch September 8, 2023 20:04

jsf9k mentioned this pull request Sep 14, 2023

Initial implementation cisagov/skeleton-golang-package#2

Open

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add nix flake #27

Add nix flake #27

jasonodoom commented Aug 23, 2023 •

edited by jsf9k

jsf9k left a comment

dav3r commented Aug 23, 2023

dav3r left a comment

dav3r commented Aug 23, 2023

mcdonnnj commented Aug 23, 2023

mcdonnnj left a comment

dav3r commented Aug 23, 2023

jsf9k left a comment

dav3r left a comment

jsf9k commented Sep 7, 2023

mcdonnnj left a comment

Add nix flake #27

Add nix flake #27

Conversation

jasonodoom commented Aug 23, 2023 • edited by jsf9k

🗣 Description

💭 Motivation and context

🧪 Testing

✅ Pre-approval checklist

jsf9k left a comment

Choose a reason for hiding this comment

dav3r commented Aug 23, 2023

dav3r left a comment

Choose a reason for hiding this comment

dav3r commented Aug 23, 2023

mcdonnnj commented Aug 23, 2023

mcdonnnj left a comment

Choose a reason for hiding this comment

dav3r commented Aug 23, 2023

jsf9k left a comment

Choose a reason for hiding this comment

dav3r left a comment

Choose a reason for hiding this comment

jsf9k commented Sep 7, 2023

mcdonnnj left a comment

Choose a reason for hiding this comment

jasonodoom commented Aug 23, 2023 •

edited by jsf9k