Chore: fix template/readme and update release PR scripts (#257)

* improve template and readme

* release scripts

* update release PR workflow

Author: stegaBOB

.github/workflows/create-release-pr.yml

@@ -47,6 +47,12 @@ jobs:
         id: version
         uses: ./.github/actions/detect-version
 
+      - name: Update CHANGELOG.md
+        run: scripts/update_changelog.sh ${{ steps.version.outputs.version }}
+
+      - name: Update CLI template version
+        run: scripts/update_template_version.sh ${{ steps.version.outputs.version }}
+
       - name: Configure Actions Bot
         uses: ./.github/actions/configure-actions-bot
 

README.md

@@ -76,9 +76,9 @@ pub enum CounterInstructionSet {
     Increment(Increment),
 }
 
-#[derive(Align1, Pod, Zeroable, Default, Copy, Clone, Debug, Eq, PartialEq, ProgramAccount)]
+#[zero_copy(pod)]
+#[derive(ProgramAccount, Default, Debug, Eq, PartialEq)]
 #[program_account(seeds = CounterSeeds)]
-#[repr(C, packed)]
 pub struct CounterAccount {
     pub authority: Pubkey,
     pub count: u64,

scripts/update_changelog.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+# Update CHANGELOG.md for a new release
+# Takes the new version as the first argument
+
+set -e  # Exit on any error
+
+# Check if version is provided
+if [ $# -eq 0 ]; then
+    echo "Error: Version parameter is required"
+    echo "Usage: $0 <version>"
+    exit 1
+fi
+
+VERSION=$1
+DATE=$(date +%Y-%m-%d)
+
+# Path to the CHANGELOG.md file
+CHANGELOG_FILE="CHANGELOG.md"
+
+if [ ! -f "$CHANGELOG_FILE" ]; then
+    echo "Error: CHANGELOG.md not found at $CHANGELOG_FILE" >&2
+    exit 1
+fi
+
+# Get the previous version from the changelog for link generation
+PREVIOUS_VERSION=$(grep "^## \[" "$CHANGELOG_FILE" | head -2 | tail -1 | sed 's/.*\[\([0-9.]*\)\].*/\1/')
+
+if [ -z "$PREVIOUS_VERSION" ]; then
+    PREVIOUS_VERSION="HEAD"
+fi
+
+# Add new version section after [Unreleased]
+# This replaces the [Unreleased] line with itself + blank line + new version section
+sed -i "s|^## \[Unreleased\]$|## [Unreleased]\\
+\\
+## [$VERSION] - $DATE|" "$CHANGELOG_FILE"
+
+# Add the new version link at the bottom
+sed -i "/^\[unreleased\]:/a\\[$VERSION]: https://github.com/staratlasmeta/star_frame/compare/v$PREVIOUS_VERSION...v$VERSION" "$CHANGELOG_FILE"
+
+# Update the [unreleased] link to compare from the new version
+sed -i "s|\[unreleased\]:.*|\[unreleased\]: https://github.com/staratlasmeta/star_frame/compare/v$VERSION...HEAD|" "$CHANGELOG_FILE"
+
+# Verify the change
+if ! grep -q "## \[$VERSION\] - $DATE" "$CHANGELOG_FILE"; then
+    echo "Error: CHANGELOG.md update verification failed" >&2
+    exit 1
+fi
+
+echo "CHANGELOG.md updated for version $VERSION"

scripts/update_template_version.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# Script to update the star_frame version in the template cargo_toml
+# Takes the new version as the first argument
+
+set -e  # Exit on any error
+
+# Check if version is provided
+if [ $# -eq 0 ]; then
+    echo "Error: Version parameter is required"
+    echo "Usage: $0 <version>"
+    exit 1
+fi
+
+VERSION=$1
+
+# Path to the template cargo_toml file
+TEMPLATE_FILE="star_frame_cli/src/template/cargo_toml"
+
+if [ ! -f "$TEMPLATE_FILE" ]; then
+    echo "Error: Template file not found at $TEMPLATE_FILE" >&2
+    exit 1
+fi
+
+# Update the star_frame version in the template
+sed -i "s/star_frame = { version = \"[^\"]*\"/star_frame = { version = \"$VERSION\"/" "$TEMPLATE_FILE"
+
+# Verify the change
+if ! grep -q "star_frame = { version = \"$VERSION\"" "$TEMPLATE_FILE"; then
+    echo "Error: Version update verification failed" >&2
+    exit 1
+fi
+
+echo "Template updated to version $VERSION"

star_frame/src/util.rs

@@ -65,7 +65,7 @@ pub fn uninit_array_bytes<T: NoUninit, const N: usize>(array: &[T; N]) -> &[u8]
 
 /// Quicker way to compare 32 bytes.
 ///
-/// From [Typhoon](https://github.com/exotic-markets-labs/typhoon/blob/60c5197cc632f1bce07ba27876669e4ca8580421/crates/accounts/src/utils.rs#L2)
+/// Adapted from [Typhoon](https://github.com/exotic-markets-labs/typhoon/blob/60c5197cc632f1bce07ba27876669e4ca8580421/crates/accounts/src/utils.rs#L2)
 #[inline]
 #[must_use]
 pub fn fast_32_byte_eq(a: &[u8; 32], b: &[u8; 32]) -> bool {

star_frame_cli/src/template/cargo_toml

@@ -9,7 +9,9 @@ publish = false
 release.release = false
 
 [lib]
-crate-type = ["cdylib", "lib"]
+# Using only `cdylib` enables the compiler to optimize with LTO. If you need to use the library, make a separate lib crate
+# or add `rlib` here if the performance impact is acceptable.
+crate-type = ["cdylib"]
 name = "{name_lowercase}"
 
 [features]
@@ -18,7 +20,7 @@ idl = ["star_frame/idl"]
 
 [profile.release]
 overflow-checks = true
-lto = "fat"
+lto = "thin"
 codegen-units = 1
 
 [dependencies]

star_frame_cli/src/template/states_rs

@@ -6,9 +6,9 @@ pub struct CounterAccountSeeds {
     pub authority: Pubkey,
 }
 
-#[derive(Align1, Pod, Zeroable, Default, Copy, Clone, Debug, Eq, PartialEq, ProgramAccount)]
+#[zero_copy(pod)]
+#[derive(Default, Debug, Eq, PartialEq, ProgramAccount)]
 #[program_account(seeds = CounterAccountSeeds)]
-#[repr(C, packed)]
 pub struct CounterAccount {
     pub authority: Pubkey,
     pub count: u64,