Skip to content

Commit

Permalink
Prep for 0.3.5 release (#271)
Browse files Browse the repository at this point in the history
I updated the CMake version number to 0.3.5.  Note that the URL doesn't
exist yet.  This is expected (see `RELEASE.md`); we'll make it exist as
part of the release process.

Separately, in the docs, I fixed up our bazel installation instructions,
because they were referring to a very old release.  The major change
here was to point users towards the manually uploaded archive file,
rather than the automatically generated one, because the former is
stable but the latter is not.
  • Loading branch information
chiphogg authored Jul 23, 2024
1 parent 569da0a commit eac6c14
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ cmake_minimum_required(VERSION 3.24...3.29)

project(
Au
VERSION 0.3.4
VERSION 0.3.5
DESCRIPTION "A C++ quantities and units library, by Aurora Innovation"
HOMEPAGE_URL "https://aurora-opensource.github.io/au/0.3.4/"
HOMEPAGE_URL "https://aurora-opensource.github.io/au/0.3.5/"
LANGUAGES CXX
)

Expand Down
20 changes: 10 additions & 10 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,34 +209,34 @@ Now you have a file, `~/au.hh`, which you can add to your `third_party` folder.
#### bazel

1. **Choose your Au version**.
- This can be a tag, or a commit hash. Let's take `0.2.0` as an example.
- This can be a tag, or a commit hash. Let's take `0.3.4` as an example.

2. **Form the URL to the archive**.
- For `0.2.0`, this would be:
- For `0.3.4`, this would be:
```
https://github.com/aurora-opensource/au/archive/0.2.0.tar.gz
NOTE: Your au version ID goes HERE ^^^^^
https://github.com/aurora-opensource/au/releases/download/0.3.4/au-0.3.4.tar.gz
NOTE: Your au version ID goes HERE ^^^^^ ^^^^^
```
3. **Compute your SHA256 hash**.
1. Follow the URL from the previous step to download the archive.
2. Compute the SHA256 hash: `sha256sum au-0.2.0.tar.gz`
2. Compute the SHA256 hash: `sha256sum au-0.3.4.tar.gz`
3. The first token that appears is the hash. Save it for the next step.
4. **Add `http_archive` rule to `WORKSPACE`**.
- Follow this pattern:
```python
http_archive(
name = "au",
sha256 = "bdaec065b35f44af2cb22def5b69ac08ca40c47791ea3ed2eb3ebf3e85b3e0b0",
strip_prefix = "au-0.2.0",
urls = ["https://github.com/aurora-opensource/au/archive/0.2.0.tar.gz"],
sha256 = "dd0f97e2720f02e3c5531a912c21b8eb889fcb984bac5f5f8b0f00e16b839216",
strip_prefix = "au-0.3.4",
urls = ["https://github.com/aurora-opensource/au/releases/download/0.3.4/au-0.3.4.tar.gz"],
)
```
- In particular, here's how to fill out the fields:
- `sha256`: Use the SHA256 hash you got from step 3.
- `strip_prefix`: write `"au-0.2.0"`, except use your ID from step 1 instead of `0.2.0`.
- `strip_prefix`: write `"au-0.3.4"`, except use your ID from step 1 instead of `0.3.4`.
- `urls`: This should be a list, whose only entry is the URL you formed in step 2.
At this point, the Au library is installed, and you can use it in your project!
Expand Down Expand Up @@ -308,7 +308,7 @@ In either case, here are the main targets and include files provided by the Au l
```
If you want a specific release, check out the tag you want. Note that the first version of Au
that supports CMake will be 0.3.5.
that supports CMake is 0.3.5.
```sh
# Optional, but recommended:
Expand Down

0 comments on commit eac6c14

Please sign in to comment.