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

Build Dagger docs with Dagger #7396

Merged
merged 1 commit into from
May 17, 2024
Merged

Build Dagger docs with Dagger #7396

merged 1 commit into from
May 17, 2024

Conversation

shykes
Copy link
Contributor

@shykes shykes commented May 16, 2024

Examples:

  • Build the docs site: dagger call --source=. site export --path=./docs-site
  • Build the docs server: dagger call --source=. server
  • Run docs locally: dagger call --source=. server as-service up
  • Run docs for a PR: dagger call --source=https://github.com/dagger/dagger#pull/7382/head server as-service up

@shykes shykes changed the title Serve docs locally using dagger Build Dagger docs with Dagger May 17, 2024
ci/docs.go Show resolved Hide resolved
@shykes
Copy link
Contributor Author

shykes commented May 17, 2024

To test that this PR works:

dagger -m github.com/dagger/dagger@pull/7396/head call --source=github.com/dagger/dagger#pull/7396/head \
 docs \
 server \
 as-service \
 up

Meta: I have notes on the UX of this command:

  1. I reference the same remote git branch twice, but have to use two different syntaxes (# vs @) (is there an issue for this? cc @helderco @jedevc @vito )
  2. server as-service up... Container.up() #7399
  3. How do I hook up Dagger Cloud so that I can run it on my laptop, and the result is added as a check on this PR? cc @aluzzardi @vito @crjm

@vito
Copy link
Contributor

vito commented May 17, 2024

I reference the same remote git branch twice, but have to use two different syntaxes (# vs @) (is there an issue for this? cc @helderco @jedevc @vito )

This was part of the refs v2 idea, unifying module ref syntax with git ref syntax. Not sure if there's a path to that from @grouville's current work on VCS-independent refs. Maybe?

How do I hook up Dagger Cloud so that I can run it on my laptop, and the result is added as a check on this PR? cc @aluzzardi @vito @crjm

This was disabled for now because it seemed too unusual, wanted to give it more thought. Now the checks will be only added if it's CI=true. I wonder if you could fool it with env CI=true dagger call ...?

@shykes shykes requested a review from jedevc May 17, 2024 22:59
Examples:

- Build the docs site: `dagger call --source=. site export --path=./docs-site`
- Build the docs server: `dagger call --source=. server`
- Run docs locally: `dagger call --source=. server as-service up`
- Run docs for a PR: `dagger call --source=https://github.com/dagger/dagger#pull/7382/head server as-service up`

Signed-off-by: Solomon Hykes <solomon@dagger.io>
Signed-off-by: Jeremy Adams <jeremy@dagger.io>
Signed-off-by: Kyle Penfound <kyle@dagger.io>
@shykes shykes merged commit da68978 into dagger:main May 17, 2024
93 checks passed
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.

None yet

3 participants