Skip to content
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.

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

ADR to use asdf for node as well as golang #386

Merged
merged 15 commits into from
Jul 21, 2023
Merged

Conversation

brandonlenz
Copy link
Contributor

@brandonlenz brandonlenz commented Jul 19, 2023

Companion PR to transcom/mymove#11053

Changes

  • Adds the ADR reasoning the change
  • Updates this repo to use asdf for node
  • Updates this repo's node version
  • Updates documentation to prefer asdf over nodenv
  • Updates documentation of setup commands and scripts that previously expected .tool-versions to only contain the golang version

@brandonlenz brandonlenz requested a review from a team July 19, 2023 16:37
Copy link
Contributor

@rogeruiz rogeruiz left a comment

Choose a reason for hiding this comment

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

❌ This PR needs changes ...

Great work on this, @brandonlenz. There's a small typo to address. I added comments on the other files but those were mostly praise or calling out possible fast-follow PRs to this work and are otherwise non-blocking comments around being too specific in the documentation around version numbers changing.

.github/workflows/deploy.yml Show resolved Hide resolved
.node-version Show resolved Hide resolved
docs/backend/guides/how-to/manage-golang-with-asdf.md Outdated Show resolved Hide resolved
docs/backend/guides/how-to/upgrade-node.md Show resolved Hide resolved
nix/default.nix Show resolved Hide resolved
@brandonlenz brandonlenz requested a review from rogeruiz July 20, 2023 21:33
Copy link
Contributor

@rogeruiz rogeruiz left a comment

Choose a reason for hiding this comment

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

lgtm 🌈

Copy link
Contributor

@YanZ777 YanZ777 left a comment

Choose a reason for hiding this comment

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

I have a few questions that I left in a comment on the ADR.

Thanks for being extra thorough and updating all the documentation along with writing up an ADR!

* Do nothing, keep using asdf for golang and nodenv for node
* Use asdf to manage golang and node versions

## Decision Outcome
Copy link
Contributor

Choose a reason for hiding this comment

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

questions:

Do we need to mention somewhere here that going forward folks will use asdf? (i.e. if you have been using nodenv in the past, you're still welcome to use nodenv, but new folks will use asdf)

Also, do we want to have a ticket or something else to revisit migrating everyone over? I think getting everyone to use asdf would be useful for being able to help each other.

Other side question. How do folks migrate to using allowing asdf to manage their node version and go version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a quick guide for switching from Nodenv to asdf:

437c55c

Copy link
Contributor Author

@brandonlenz brandonlenz Jul 21, 2023

Choose a reason for hiding this comment

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

Once merged, I do plan on putting out an announcement on slack, and volunteer to help anyone who tries to switch and gets stuck. With these PRs, anyone going through the docs and setup going forward would not be directed to Nodenv

I think a ticket in the backlog to switch everyone over and then remove nodenv related docs once and for all is a good idea

@mergify mergify bot merged commit 7da8be0 into main Jul 21, 2023
@mergify mergify bot deleted the bl-adr-use-asdf-for-node branch July 21, 2023 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants