Skip to content

Conversation

@aduh95
Copy link
Contributor

@aduh95 aduh95 commented Nov 16, 2025

With #1004 landed, it probably makes little sense for users to encrypt their entire config file, and instead only encrypt tokens. This PR updates the doc to remove mention of full config file encryption, and present token encryption as the default / recommended way for storing them.

@codecov
Copy link

codecov bot commented Nov 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.58%. Comparing base (7342aff) to head (9dc54d4).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1005      +/-   ##
==========================================
- Coverage   80.65%   80.58%   -0.08%     
==========================================
  Files          39       39              
  Lines        4746     4754       +8     
==========================================
+ Hits         3828     3831       +3     
- Misses        918      923       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aduh95 aduh95 requested a review from joyeecheung November 28, 2025 11:16
README.md Outdated

Note: you could use `ncu-config` to configure these variables, but it's not
recommended to leave your tokens in your command line history.
Note: Encryption is available only if you have `gpg` setup on your machine. If
Copy link
Member

Choose a reason for hiding this comment

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

I think we should just split it into two different instructions with the encryption one prioritized as "Recommended". It's going to catch people off guard to recommend -x first only to come back with a note saying they should setup gpg first - that sounds like a pre-requisite that should be mentioned before we suggest the -x flag (and also, what if you don't have gpg set up? The doc provides no suggestions, and it is not great to leave new contributors guessing what they should do in that case when they are new to all this and are just trying to set it up).

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've added "With encryption"/"Without encryption" variants, PTAL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants