Fix release build workflow; remove extra line in changelog (danlehmann#88)

* Fix release build workflow; remove extra line in changelog

* Make examples no longer fail cargo test

Makes the example a lot less useful, but I can't find a nicer way
to stop this from failing the build.

Author: danlehmann

.github/workflows/test-release.yml

@@ -21,6 +21,7 @@ jobs:
         with:
           toolchain: stable
       - uses: actions-rs/cargo@v1
+        with:
           command: test
           args: ${{ matrix.args }}
 

bitbybit/CHANGELOG.md

@@ -1,9 +1,9 @@
 # Changelog
 
-## unreleased
-
 ## bitbybit 1.4.0
 
+This is the final version to support arbitrary-int 1.x. Future versions will require arbitrary-int 2.x.
+
 ### Added
 
 - `*_mask()`, as well as `*_BITS`, `*_COUNT`, and `*_STRIDE` constants for fields that provide some information on a

bitbybit/examples/defmt_bitfields.rs

@@ -1,21 +1,25 @@
-use arbitrary_int::u4;
-use bitbybit::bitfield;
+#[cfg(feature = "examples")]
+pub fn main() {
+    use arbitrary_int::u4;
+    use bitbybit::bitfield;
 
-#[bitfield(u32, defmt_bitfields)]
-pub struct BitfieldU32 {
-    #[bits(28..=31, rw)]
-    val3: u4,
-    #[bits(24..=27, rw)]
-    val2: u4,
-    #[bits(16..=23, rw)]
-    val1: u8,
-    #[bits(0..=15, rw)]
-    val0: u16,
-}
+    #[bitfield(u32, defmt_bitfields)]
+    pub struct BitfieldU32 {
+        #[bits(28..=31, rw)]
+        val3: u4,
+        #[bits(24..=27, rw)]
+        val2: u4,
+        #[bits(16..=23, rw)]
+        val1: u8,
+        #[bits(0..=15, rw)]
+        val0: u16,
+    }
 
-pub fn main() {
     let bitfield = BitfieldU32::new_with_raw_value(0x0);
     defmt_impl_check(&bitfield);
 }
 
 pub fn defmt_impl_check<T: defmt::Format>(_: &T) {}
+
+#[cfg(not(feature = "examples"))]
+pub fn main() {}

bitbybit/examples/defmt_fields.rs

@@ -1,21 +1,24 @@
-use arbitrary_int::u4;
-use bitbybit::bitfield;
-
-#[bitfield(u32, defmt_fields)]
-pub struct BitfieldU32 {
-    #[bits(28..=31, rw)]
-    val3: u4,
-    #[bits(24..=27, rw)]
-    val2: u4,
-    #[bits(16..=23, rw)]
-    val1: u8,
-    #[bits(0..=15, rw)]
-    val0: u16,
-}
-
+#[cfg(feature = "examples")]
 pub fn main() {
+    use arbitrary_int::u4;
+    use bitbybit::bitfield;
+    #[bitfield(u32, defmt_fields)]
+    pub struct BitfieldU32 {
+        #[bits(28..=31, rw)]
+        val3: u4,
+        #[bits(24..=27, rw)]
+        val2: u4,
+        #[bits(16..=23, rw)]
+        val1: u8,
+        #[bits(0..=15, rw)]
+        val0: u16,
+    }
+
     let bitfield = BitfieldU32::new_with_raw_value(0x0);
     defmt_impl_check(&bitfield);
 }
 
 pub fn defmt_impl_check<T: defmt::Format>(_: &T) {}
+
+#[cfg(not(feature = "examples"))]
+pub fn main() {}

bitbybit/src/bitfield/parsing.rs

@@ -205,7 +205,7 @@ fn parse_field(base_data_size: usize, field: &Field) -> Result<FieldDefinition>
                             if !is_in_array && !is_range {
                                 return Err(Error::new_spanned(
                                     &range_span,
-                                    "bitfield!: bit requires an inclusive range, for examples bits(10..=19). bit(10) allows specifying a single bit",
+                                    "bitfield!: bit requires an inclusive range, for example bits(10..=19). bit(10) allows specifying a single bit",
                                 ));
                             }
                             ranges.push(Range {
@@ -217,7 +217,7 @@ fn parse_field(base_data_size: usize, field: &Field) -> Result<FieldDefinition>
                             if is_range && !is_in_array {
                                 return Err(Error::new_spanned(
                                     &range_span,
-                                    "bitfield!: bits requires a single bit, for examples bit(10). bits(10..=12) can be used to specify multiple bits",
+                                    "bitfield!: bits requires a single bit, for example bit(10). bits(10..=12) can be used to specify multiple bits",
                                 ));
                             }
                             ranges.push(Range {