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

Add usage notice in readme file #10

Merged
merged 2 commits into from
Jan 31, 2023
Merged

Conversation

brettaufheber
Copy link
Member

No description provided.

@brettaufheber brettaufheber requested review from gebae and pathob January 8, 2023 16:56
@pathob
Copy link
Member

pathob commented Jan 11, 2023

Good start, but my main concern still exists: A cache should clean up old entries at some point and it's not documented whether or how that works.

@brettaufheber
Copy link
Member Author

@pathob
I added a notice in the readme that there is currently no cleanup mechanism implemented.

For this purpose i created a an issue: #11

Copy link
Collaborator

@gebae gebae left a comment

Choose a reason for hiding this comment

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

In principle it is ok for me, but:

  • A hint in the readme, how the cache entry hash is calculated, could be helpful for the users.
  • It is not 100% clear, if the "parameters for all artifact types" can be used together with the resolve-using-config task. If yes, it would mean that the documentation of the cache-dir parameter for the resolve-using-config task is redundant.
  • It is also not clear, if the cache-dir parameter can be part of the JSON config file (why not, actually?).

@brettaufheber
Copy link
Member Author

Hello @gebae,
thank you for your review.
I will improve the readme file according to your suggestions.

@brettaufheber brettaufheber force-pushed the feature/readme_update branch 3 times, most recently from d6c34aa to bd39e8e Compare January 29, 2023 05:39
@brettaufheber brettaufheber merged commit 2d2e1ba into main Jan 31, 2023
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.

3 participants