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

Ignore config directory symlink in development #56639

Merged
merged 1 commit into from
Sep 25, 2021
Merged

Ignore config directory symlink in development #56639

merged 1 commit into from
Sep 25, 2021

Conversation

frenck
Copy link
Member

@frenck frenck commented Sep 25, 2021

Proposed change

I've recently adopted a different workflow, allowing me to have multiple git worktrees available using different Python environments (3.9 + 3.10).

I do share the Home Assistant development configuration between those environments using a simple symlink.

mkdir -p ~/code/home-asistant/core
cd ~/code/home-asistant/core

git clone --bare [email protected]:home-assistant/core.git .bare
echo "gitdir: .bare" > .git

# Set up `dev` branch work environment
git worktree add dev
cd dev
pyenv virtualenv 3.9.7 home-assistant-core-3.9.7
pyenv local home-assistant-core-3.9.7
./script/setup

# Take out the config folder, making it centralized
mv ./config ../.config
ln -s ../.config config

Now I can quickly create other worktrees with shared or different environments:

# Create second worktree
cd ~/code/home-asistant/core
git worktree add 3.10 dev
cd 3.10
pyenv virtualenv 3.10.0rc2 home-assistant-core-3.10
pyenv local home-assistant-core-3.10
ln -s ../.config config
./script/setup

Due to this way of working, the development config folder is centralized, however, symlinked.

This PR adjusts the .gitignore to allow both the current and the case in my workflow above.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant probot-home-assistant bot added new-feature small-pr PRs with less than 30 lines. labels Sep 25, 2021
.gitignore Show resolved Hide resolved
@frenck frenck merged commit fabf520 into dev Sep 25, 2021
@frenck frenck deleted the frenck-2021-2392 branch September 25, 2021 10:53
@github-actions github-actions bot locked and limited conversation to collaborators Sep 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed new-feature small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants