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

Read README from flake's store path #81

Merged

Conversation

cole-h
Copy link
Member

@cole-h cole-h commented Sep 18, 2023

Before, we were reading the README from the current working directory because of a couple things:

  • We were reading entry.file_name() instead of entry.path(), which would be something like README.md, instead of a full path to the file. This would lead to reading the README.md (if it existed) from the current directory rather than the directory we just searched through.

  • We were using the flake_root (the root of the git repository) to find the README. This would mean that we would read the README.md from wherever this git root was, rather than from the flake itself. Now, we read it from the flake's store path.

Before, we were reading the README from the current working directory
because of a couple things:

* We were reading `entry.file_name()` instead of `entry.path()`, which
would be something like `README.md`, instead of a full path to the file.
This would lead to reading the `README.md` (if it existed) from the
current directory rather than the directory we just searched through.

* We were using the `flake_root` (the root of the git repository) to
find the README. This would mean that we would read the `README.md` from
wherever this git root was, rather than from the flake itself. Now, we
read it from the flake's store path.
Copy link
Contributor

@Hoverbear Hoverbear left a comment

Choose a reason for hiding this comment

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

Seems to work for me. :)

@Hoverbear
Copy link
Contributor

@cole-h cole-h merged commit 1b4b882 into main Sep 19, 2023
5 checks passed
@cole-h cole-h deleted the cole/ds-1077-readmemd-is-read-from-passed-directory-not-from-nix branch September 19, 2023 19:44
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