Skip to content

fix(docs): fix local builds with earthly and Just #500

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

Merged
merged 2 commits into from
Aug 26, 2025
Merged

fix(docs): fix local builds with earthly and Just #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37554ef
fix(docs): fix local builds with earthly and Just
stevenj Aug 26, 2025
6bb0cf8
fix(docs): Remove CDDL from checks until we actually have it
stevenj Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions specs/Earthfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,21 @@ src:

SAVE ARTIFACT signed_doc.json

# Regenerate the json spec file.
regenerate-json:
FROM +src
# Make sure keys are sorted so its both reproducible, AND diffs easily.
RUN cd definitions; \
cue export -f -s ./signed_docs/docs:signed_docs --out json | jq -S > ../signed_doc.json

SAVE ARTIFACT --keep-ts signed_doc.json

# Regenerate the full signed document specification json file.
regenerate:
FROM +src

COPY +regenerate-json/signed_doc.json .

# Make sure keys are sorted so its both reproducible, AND diffs easily.
RUN cd definitions; \
cue export -f -s ./signed_docs/docs:signed_docs --out json | jq -S > ../signed_doc.json
Expand All @@ -37,6 +48,12 @@ regenerate:
SAVE ARTIFACT --keep-ts signed_doc.json
SAVE ARTIFACT --keep-ts ../gen gen

regenerate-local-json:
FROM +regenerate-json

SAVE ARTIFACT signed_doc.json AS LOCAL signed_doc.json


regenerate-local:
FROM +regenerate

Expand All @@ -48,6 +65,8 @@ regenerate-local:
check:
FROM +src
RUN cue fmt --check -s --files ./definitions
# RUN cd definitions; \
# cue vet ./cddl
RUN cd definitions; \
cue vet ./signed_docs/docs:signed_docs ../signed_doc.json

Expand Down
10 changes: 4 additions & 6 deletions specs/Justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Developer convenience functions

# required to get cuelang to enable file embedding
export CUE_EXPERIMENT := "embed"
export CUE_EXPERIMENT := "evalv3=0"
default:
@just --list --unsorted

Expand All @@ -19,16 +19,14 @@ format:

# Check the signed document cue files are valid.
check: format
cd definitions; cue vet ./signed_docs/docs:signed_docs -c
cd definitions; cue vet ./form_template/elements:form_template -c
earthly +check

# Regenerate the full signed document specification json file.
regenerate-signed-doc-json:
# Make sure keys are sorted so its both reproducible, AND diffs easily.
cd definitions; cue export -f -s ./signed_docs/docs:signed_docs --out json | jq -S > ../signed_doc.json
earthly +regenerate-local-json

# Fix and Check Markdown files
regenerate: check regenerate-signed-doc-json validate && validate-docs
regenerate:
earthly +regenerate-local
rm -rf "../docs/src/architecture/08_concepts/signed_doc"
mv temp_gen "../docs/src/architecture/08_concepts/signed_doc"
Expand Down
Loading