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.

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

Improve contributing docs #9732

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Improve contributing docs #9732

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3278d8d
Add reference to CONTRIBUTING in readme.
KronosTheLate Nov 4, 2024
b276d09
Move the "updating" instruction to the top
KronosTheLate Nov 4, 2024
e0d9409
Remove promise about step-by-step instructions
KronosTheLate Nov 4, 2024
f1d1d26
re-adddouble spaces
KronosTheLate Nov 4, 2024
462e892
Make clear the GitHub specific reccomendation
KronosTheLate Nov 18, 2024
8d9b332
Update README.md
KronosTheLate Nov 18, 2024
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
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,19 @@ This repository contains recipes for building binaries for Julia packages using

## Contributing

To contribute a new recipe, you can either
For detailed information about contributing, go to ["CONTRIBUTING.md"](https://github.com/JuliaPackaging/Yggdrasil/blob/master/CONTRIBUTING.md). For a quick overview, continue reading.

To update the version to build for an existing recipe, simply open a PR to this repository making the required tweaks. This usually boils down to only updating the version number and the source (e.g., URL and hash for an archive, or the revision for a git repository) of the relevant `build_tarballs.jl` file, but in some cases more changes may be needed. For an example, see [this PR](https://github.com/JuliaPackaging/Yggdrasil/pull/8833). The version number should be easy to find, and the URL + hash can be found by clicking the release, clicking the final commit in the release, and copying the information from the URL bar.
Copy link
Member

Choose a reason for hiding this comment

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

The instructions to find the commit hash are specific to github though, which isn't the only web hosting service in the world.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, but it is all I know. This should cover many (most?) cases and is therefore useful as-is, and more examples are ofc very welcome.

Copy link
Member

Choose a reason for hiding this comment

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

Still, this sounds as if it's a generic recommendation, which is not.


To contribute a new recipe, you can either
* use `BinaryBuilder.run_wizard()`, which will automatically open a pull request to this repository after a successfull build for all requested platforms
* Copy another build recipe using it as a template, and then open a manual pull request to this repository

Yggdrasil builds the tarballs using `master` version of BinaryBuilder.jl, which requires Julia 1.3.0 or later versions. Note that this BinaryBuilder.jl version has some differences compared to v0.1.4 and the builders generated are slightly different. You are welcome to contribute builders written for BinaryBuilder.jl v0.1.4, but they will likely need minor adjustements.
Yggdrasil builds the tarballs using `master` version of BinaryBuilder.jl, which requires Julia 1.3.0 or later versions. Note that this BinaryBuilder.jl version has some differences compared to v0.1.4 and the builders generated are slightly different. You are welcome to contribute builders written for BinaryBuilder.jl v0.1.4, but they will likely need minor adjustements.
KronosTheLate marked this conversation as resolved.
Show resolved Hide resolved

[Buildkite CI](https://buildkite.com/julialang/yggdrasil) is used to test that the builders can successfully produce the tarballs.

If you prefer to test your manual buildscript before opening the pull request, we suggest installing `BinaryBuilder.jl` on Julia 1.3 or any following release and running `julia --color=yes build_tarballs.jl --verbose --debug` locally. On MacOS, you will need to have `docker` installed for this to work.

### Updating the version of an existing builder

To trigger the build of a new version of the upstream package simply open a pull request to update the builder as necessary. This usually boils down to only updating the version number and the source (e.g., URL and hash for an archive, or the revision for a git repository), but in some cases more changes may be needed.
If you prefer to test your manual buildscript before opening the pull request, we suggest installing `BinaryBuilder.jl` on Julia 1.3 or any following release and running `julia --color=yes build_tarballs.jl --verbose --debug` locally. On MacOS, you will need to have `docker` installed for this to work.
KronosTheLate marked this conversation as resolved.
Show resolved Hide resolved

## Using the generated tarballs

Expand Down