Skip to content

docs: document build and test workflows#69

Merged
leerho merged 2 commits into
apache:mainfrom
PsiACE:docs/build-test
Jan 14, 2026
Merged

docs: document build and test workflows#69
leerho merged 2 commits into
apache:mainfrom
PsiACE:docs/build-test

Conversation

@PsiACE
Copy link
Copy Markdown
Member

@PsiACE PsiACE commented Jan 14, 2026

Closes #68

@PsiACE
Copy link
Copy Markdown
Member Author

PsiACE commented Jan 14, 2026

cc @tisonkun @notfilippo

Copy link
Copy Markdown
Member

@tisonkun tisonkun left a comment

Choose a reason for hiding this comment

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

Generally LGTM. @leerho suggests to put the related info in README.md since users build from source or verifying releases may need to know.

At least we can set up a link.

I have several ideas to improve the experience and words, but I'll come up with them when I have some spare time.

@leerho leerho merged commit b2d1238 into apache:main Jan 14, 2026
9 checks passed
@PsiACE PsiACE deleted the docs/build-test branch January 15, 2026 00:59
Comment thread CONTRIBUTING.md
cargo x lint
```

## Manual workflow (without xtask)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hi @PsiACE and @tisonkun, Why do we need the manual workflow part? Why not use xtask uniformly for building, testing, and linting?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The manual workflow is hidden behind xtask, meaning most developers can safely ignore it. However, explaining how it works may be necessary.

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.

Document how to build and test

4 participants