8000 docs(sdk/java) cookbook by eunomie · Pull Request #9848 · dagger/dagger · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs(sdk/java) cookbook #9848

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(sdk/java) cookbook #9848

wants to merge 1 commit into from

Conversation

eunomie
Copy link
Member
@eunomie eunomie commented Mar 12, 2025 •
edited
Loading

Java SDK Cookbook

  • filesystem
  • builds
  • secrets
  • services
  • just-in-time artifacts
  • optimizations (except concurrent calls)
  • error handling
  • debugging

@eunomie eunomie force-pushed the sdk-java-docs-cookbook branch from fe0607b to cda6a29 Compare March 13, 2025 14:39
@eunomie
Copy link
Member Author
eunomie commented Mar 19, 2025

@dagger/docs Is that better to complete all the cookbook sections then merge it, or to merge with the actual state then open other PRs for the missing sections?

@vikram-dagger vikram-dagger added the area/documentation Improvements or additions to documentation label Mar 20, 2025
@github-actions GitHub Actions
Copy link
Contributor
github-actions bot commented Apr 4, 2025

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@vikram-dagger
Copy link
Contributor
vikram-dagger commented Apr 4, 2025 •
edited
Loading

@dagger/docs Is that better to complete all the cookbook sections then merge it, or to merge with the actual state then open other PRs for the missing sections?

Both options are fine, so long as you ensure that each PR covers one (or more) complete sections rather than individual recipes (as otherwise it will look very inconsistent).

vikram-dagger
vikram-dagger reviewed Apr 9, 2025
View reviewed changes
docs/current_docs/cookbook/cookbook.mdx Outdated

<TabItem value="Java">

```java file=./snippets/copy-dir/java/MyModule.java
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if this is an oversight but in other sections of the docs we have created a complete module and directory tree structure for each snippet. We should do the same here, as that will make it easier to implement automated testing in future.

Copy link
Member Author

Choose a reason for hiding this comment

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

🤔 I think I saw that on some other docs section and as it was easier to do... But maybe I'm wrong.
I'll use complete module structure 👍

docs/current_docs/cookbook/snippets/clone-git-repository/java/MyModule.java Outdated
@Object
public class MyModule {
@Function
public Container clone(String repository, String locator, String ref) {
Copy link
Contributor
@vikram-dagger vikram-dagger Apr 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This recipe has changed and there is also an additional recipe in this section for SSH cloning of private repositories: #10092 and #9770

@vikram-dagger
Copy link
Contributor

@eunomie note that there are some additional recipes incoming for the filesystem section, please feel free to update #10074 with Java equivalents.

@github-actions GitHub Actions
Copy link
Contributor

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@eunomie eunomie force-pushed the sdk-java-docs-cookbook branch 2 times, most recently from 8a761b6 to 77c4741 Compare May 12, 2025 13:48
@eunomie
docs(sdk/java) cookbook
59d425a 
Signed-off-by: Yves Brissaud <gh@lgtd.io>
@eunomie eunomie force-pushed the sdk-java-docs-cookbook branch from 77c4741 to 59d425a Compare May 12, 2025 15:43
@eunomie eunomie marked this pull request as ready for review May 12, 2025 15:43
@eunomie eunomie requested a review from a team as a code owner May 12, 2025 15:43
@github-actions GitHub Actions
Copy link
Contributor

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions GitHub Actions
Copy link
Contributor

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@jasonmccallister
Copy link
Member

@eunomie removing the stale tag from this assuming its still valid.

I'm not sure on @jpadams thoughts here, but if we are only missing two sections maybe we should merge as is and follow up with PRs for those sections?

@github-actions GitHub Actions
Copy link
Contributor

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vikram-dagger vikram-dagger vikram-dagger left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation kind/stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@eunomie @vikram-dagger @jasonmccallister
0