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

Move secrets to a new file secrets.h add add to gitignore #47

Merged
merged 3 commits into from
Oct 20, 2021
Merged

Move secrets to a new file secrets.h add add to gitignore #47

merged 3 commits into from
Oct 20, 2021

Conversation

BeldrothTheGold
Copy link
Contributor

Description

  • Move secrets, such as Wifi network, and credentials to secrets.h. This file is added to .gitignore.
    This should make it so users don't need to worry about publishing their network SSID/password when committing changes.

  • Also, moves NTP network address to define at top of ntptimeclient.h

Contributing requirements

  • I read the contribution guidelines in CONTRIBUTING.md.
  • I understand the BlinkenPerBit metric, and maximized it in this PR.
  • I selected main as the target branch.
  • All code herein is subjected to the license terms in COPYING.txt.

…k to ntptimeclient.h so it's consistent with the rest of the project (with the exception of secrets)
removes lib/* from this version of .gitignore it's not part of this PR
@BeldrothTheGold
Copy link
Contributor Author

I thought about also moving the NTP address to secrets.h since it's going to be different for different folks. What do you think?

@davepl
Copy link
Contributor

davepl commented Oct 15, 2021 via email

@BeldrothTheGold
Copy link
Contributor Author

Yes, exactly.

@davepl
Copy link
Contributor

davepl commented Oct 20, 2021

Nicely done, thanks!

@davepl davepl merged commit 788c4cd into PlummersSoftwareLLC:main Oct 20, 2021
@BeldrothTheGold
Copy link
Contributor Author

BeldrothTheGold commented Oct 21, 2021

Cool…. So does that have the effect of there’s a “default” secrets.h, which you can edit or replace locally, but when you commit your changes get ignored? Clever! - Dave

Man, I am super embarrassed.
You cannot make git ignore changes in a tracked file this way.
Folks will need to run the following command after cloning the project to prevent changes from being tracked in secrets.h

git update-index --assume-unchanged include/secrets.h

@BeldrothTheGold BeldrothTheGold deleted the move_secrets branch October 27, 2021 15:35
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