Merge pull request #283 from rust-osdev/release

Prepare for v0.11 release and fix remaining issues

Author: phil-opp

Diff for: .github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  release:
+    name: "Release"
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    environment: crates_io_release
+
+    steps:
+      - name: "Checkout Repository"
+        uses: actions/checkout@v1
+
+      - run: cargo publish -p bootloader_api
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+      - run: cargo publish -p bootloader-x86_64-bios-common
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+      - run: cargo publish -p bootloader-x86_64-common
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+      - run: cargo publish -p bootloader-x86_64-bios-boot-sector --no-verify
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+      - run: cargo publish -p bootloader-x86_64-bios-stage-2 --no-verify
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+      - run: cargo publish -p bootloader-x86_64-bios-stage-3 --no-verify
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+      - run: cargo publish -p bootloader-x86_64-bios-stage-4 --no-verify
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+      - run: cargo publish -p bootloader-x86_64-uefi --no-verify
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+      - run: cargo publish -p bootloader
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

Diff for: .github/workflows/trigger-release.yml

@@ -0,0 +1,23 @@
+name: Trigger Release
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  check:
+    name: Trigger Release
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Install Python Libraries"
+        run: python -m pip install --user -r .github/workflows/trigger-release/requirements.txt
+
+      - name: "Run release script"
+        run: "python3 .github/workflows/trigger-release/trigger-release.py"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Diff for: .github/workflows/trigger-release/requirements.txt

@@ -0,0 +1 @@
+toml

Diff for: .github/workflows/trigger-release/trigger-release.py

@@ -0,0 +1,42 @@
+import toml
+import requests
+import subprocess
+
+cargo_toml = toml.load("Cargo.toml")
+crate_version = cargo_toml["workspace"]["package"]["version"]
+print("Detected crate version " + crate_version)
+
+api_url = "https://crates.io/api/v1/crates/bootloader/" + crate_version
+released_version = requests.get(api_url).json()
+
+if "version" in released_version:
+    version = released_version["version"]
+    assert (version["crate"] == "bootloader")
+    assert (version["num"] == crate_version)
+    print("Version " + crate_version + " already exists on crates.io")
+
+else:
+    print("Could not find version " + crate_version +
+          " on crates.io; creating a new release")
+
+    tag_name = "v" + crate_version
+    print("  Tagging commit as " + tag_name)
+    sha = subprocess.run(["git", "rev-parse", "HEAD"], check=True,
+                         stdout=subprocess.PIPE).stdout.decode("utf-8").strip()
+    subprocess.run([
+        "gh", "api", "/repos/rust-osdev/x86_64/git/refs",
+        "-X", "POST", "-H", "Accept: application/vnd.github.v3+json",
+        "-F", "ref=refs/tags/" + tag_name,
+        "-F", "sha="+sha
+    ])
+
+    subprocess.run([
+        "gh", "api", "--method", "POST", "-H", "Accept: application/vnd.github+json",
+        "/repos/rust-osdev/bootloader/releases",
+        "-f", f"tag_name='{tag_name}'", "-f", f"target_commitish='{sha}'",
+        "-f", f"name='{tag_name}'",
+        "-f", "body='[Changelog](https://github.com/rust-osdev/bootloader/blob/main/Changelog.md)'",
+        "-F", "draft=false", "-F", "prerelease=false", "-F", "generate_release_notes=false",
+    ])
+
+    print("  Done")

Diff for: Cargo.lock

@@ -2,11 +2,11 @@ cargo-features = ["profile-rustflags"]
 
 [package]
 name = "bootloader"
-version = "0.11.0-alpha"
-authors = ["Philipp Oppermann <[email protected]>"]
-license = "MIT/Apache-2.0"
 description = "An experimental x86_64 bootloader that works on both BIOS and UEFI systems."
-repository = "https://github.com/rust-osdev/bootloader"
+license.workspace = true
+version.workspace = true
+repository.workspace = true
+authors = ["Philipp Oppermann <[email protected]>"]
 edition = "2021"
 
 [workspace]
@@ -26,12 +26,21 @@ members = [
 ]
 exclude = ["examples/basic", "examples/test_framework"]
 
+[workspace.package]
+version = "0.11.0-beta.4"
+license = "MIT/Apache-2.0"
+repository = "https://github.com/rust-osdev/bootloader"
+
+[workspace.dependencies]
+bootloader_api = { version = "0.11.0-beta.4", path = "api" }
+bootloader-x86_64-common = { version = "0.11.0-beta.4", path = "common" }
+bootloader-x86_64-bios-common = { version = "0.11.0-beta.4", path = "bios/common" }
 
 [dependencies]
 anyhow = "1.0.32"
 fatfs = "0.3.4"
 gpt = "3.0.0"
-mbrman = "0.4.2"
+mbrman = "0.5.1"
 tempfile = "3.3.0"
 
 [dev-dependencies]
@@ -50,6 +59,7 @@ lto = false
 debug = true
 overflow-checks = true
 
+# duplicated from `bios/boot_sector/Cargo.toml`
 [profile.stage-1]
 inherits = "release"
 opt-level = "s"
@@ -58,18 +68,21 @@ codegen-units = 1
 debug = false
 overflow-checks = false
 
+# duplicated from `bios/stage-2/Cargo.toml`
 [profile.stage-2]
 inherits = "release"
 opt-level = "s"
 codegen-units = 1
 debug = false
 overflow-checks = true
 
+# duplicated from `bios/stage-3/Cargo.toml`
 [profile.stage-3]
 inherits = "release"
 debug = true
 overflow-checks = true
 
+# duplicated from `bios/stage-4/Cargo.toml`
 [profile.stage-4]
 inherits = "release"
 debug = true
@@ -93,7 +106,7 @@ rustflags = [
 llvm-tools = "0.1.1"
 
 [package.metadata.docs.rs]
-default-target = "x86_64-unknown-linux-gnu"
+rustc-args = ["--cfg", "docsrs_dummy_build"]
 
 [package.metadata.release]
 dev-version = false

Diff for: Cargo.toml

@@ -1,5 +1,15 @@
 # Unreleased
 
+Major rewrite of the `bootloader` crate with various breaking changes:
+
+- **Separate API crate:** The bootloader is now split into two parts: An API crate to make kernels loadable by the bootloader and the actual bootloader implementation. This makes the build process for kernels much easier and faster.
+- **New config system:** Instead of configuring the bootloader via a special table in the `Cargo.toml`, the configuration now happens through a normal Rust struct, which is part of the `entry_point!` macro. The macro then serializes the config struct at compile time and places it in a special ELF output section. The compile time serialization happens through a manually implemented `const fn` of the config struct.
+- **Load the kernel at runtime:** The bootloader is now able to load files from FAT partitions at runtime. Thus, we don't need to link the kernel into the bootloader executable anymore. As a result, we don't need to recompile the bootloader on kernel changes anymore. We also load the config at runtime from the kernel's ELF section, which eliminates the second reason for recompiling the bootloader as well.
+- **Split into sub-crates:** Since the bootloader build process does not need access to the kernel executable or its `Cargo.toml` anymore, we can build the different parts of the bootloader independently. For example, the BIOS boot sector is now a separate crate, and the UEFI bootloader is too.
+- **Library to create disk images:** To create an abstraction the complex build steps of the different bootloader executables, we compile them inside cargo build scripts. At the top level, we provide a `bootloader` _library_ crate, which compiles everything as part of its build script. This library includes functions for creating BIOS and UEFI disk images for a given kernel. These functions can be used e.g. from a builder crate or a build script of the downstream operating system.
+
+See our [migration guides](docs/migration/README.md) for details.
+
 # 0.10.13 – 2022-09-25
 
 - Add dynamic range configuration ([#229](https://github.com/rust-osdev/bootloader/pull/229))

Diff for: Changelog.md

@@ -1,9 +1,10 @@
 [package]
 name = "bootloader_api"
-version = "0.1.0-alpha.0"
+license.workspace = true
+version.workspace = true
+repository.workspace = true
 edition = "2021"
 description = "Makes a kernel compatible with the bootloader crate"
-license = "MIT/Apache-2.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html