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

Issue877/Add config option for archive directory #965

Merged

Conversation

arhall0
Copy link
Collaborator

@arhall0 arhall0 commented Dec 4, 2024

Closes #877

This PR adds a config option to change the directory where workflows are archived. By default this is set to the same location that was used previously (~/.beeflow/archives). If you manually adjust the bee.conf option bee_archive_dir to any other folder; it will be used instead. As with the default, the folder does not need to already exist.

I tested this using the cat-grep-tar example ensuring the default behavior worked as expected. I then set bee_archive_dir = $HOMEDIR/BEE_jobs/archives with $HOMEDIR filled in as appropriate; and ensured the archived was placed in the new folder.

I ensured tests passed using:

pytest beeflow/tests

@arhall0 arhall0 added the WIP Work in progress label Dec 4, 2024
@arhall0 arhall0 self-assigned this Dec 4, 2024
@arhall0 arhall0 linked an issue Dec 4, 2024 that may be closed by this pull request
@arhall0 arhall0 added enhancement New feature or request and removed WIP Work in progress labels Dec 4, 2024
@arhall0 arhall0 requested a review from rstyd December 4, 2024 17:53
Copy link
Collaborator

@pagrubel pagrubel left a comment

Choose a reason for hiding this comment

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

Can you add some documentation on how to use this? Should it be a configuration option?

@rstyd
Copy link
Collaborator

rstyd commented Dec 4, 2024

Now that you mention it, it doesn't look like we currently have anything in the documentation that breaks down the individual configuration options, and I can't find a good place to include this info in the documentation as currently written. I propose we create a separate issue to add a page to the docs that breaks down all the config options and it'll include this as well.

@pagrubel
Copy link
Collaborator

pagrubel commented Dec 4, 2024

Sounds good

@rstyd
Copy link
Collaborator

rstyd commented Dec 4, 2024

This looks great! The only change I would recommend is to add a line to ci/bee_config.sh so that it's using your new config option. I'm also putting up an issue for changing this script so it's not hard coded since it's a pain to maintain.

Copy link
Collaborator

@rstyd rstyd left a comment

Choose a reason for hiding this comment

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

LGTM! Approved!

@rstyd rstyd merged commit 7fae94e into develop Dec 5, 2024
6 checks passed
@pagrubel pagrubel deleted the 877-add-configuration-option-to-specify-the-archive-directory branch December 16, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add configuration option to specify the archive directory
3 participants