c2pa-rs

commit ff49313c74e0a550664a12fbe02567372c22d853
parent 43b78c6c31c6418e7d61b2478301d60d72ba39ff
Author: Eric Scouten <scouten@adobe.com>
Date:   Mon, 28 Aug 2023 15:35:49 -0700

(IGNORE) Create new nightly build task (#294)

Will happen automatically at 0500 UTC every day or upon manual trigger.
Diffstat:
A
.github/workflows/nightly.yml
 | 
71
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
M
README.md
 | 
28
++++++++++++++++++++++++----

2 files changed, 95 insertions(+), 4 deletions(-)
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -0,0 +1,71 @@
+name: Nightly build
+
+on:  
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * *" # 0500 UTC every day
+
+jobs:
+  # Create snapshot of main branch for nightly build
+  nightly-snapshot:
+    name: Create snapshot
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.GH_ADMIN_COMMIT_TOKEN }}
+
+    - name: Set new proposed version
+      uses: paulhatch/semantic-version@v5.2.1
+      id: set-version
+      with:
+        tag_prefix: "v"
+        version_format: "${major}.${minor}.${patch}"
+        major_pattern: "(MAJOR)"
+        minor_pattern: "(MINOR)"
+    
+    - name: Add -nightly+(date)-(commit ID) prefix to version
+      id: set-nightly-version
+      run: |
+        echo version=${{ steps.set-version.outputs.version }}-nightly+`date +%F`-`git rev-parse --short HEAD` >> "$GITHUB_OUTPUT"
+
+    - name: Log new version & changelog
+      run: |
+        echo "Proposed new version: $VERSION"
+        echo "Nightly version: $NIGHTLY_VERSION"
+      env:
+        VERSION: ${{ steps.set-version.outputs.version }}
+        NIGHTLY_VERSION: ${{ steps.set-nightly-version.outputs.version }}
+
+    - name: Bump crate versions
+      run: |
+        sed -i "s/^version = \"[^\"]*\"$/version = \"$VERSION\"/;" sdk/Cargo.toml
+      env:
+        VERSION: ${{ steps.set-nightly-version.outputs.version }}
+    
+    - name: Install Rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+      with:
+        components: cargo
+
+    - name: Create or update Cargo.lock
+      run: |
+        cargo update -w
+        git add -f Cargo.lock
+
+    - name: Report differences for "prepare (release)" commit
+      run: git diff
+
+    - name: Commit Cargo.toml and Cargo.lock
+      uses: stefanzweifel/git-auto-commit-action@v4
+      id: commit
+      with:
+        branch: nightly
+        push_options: '--force'
+        commit_message: Prepare ${{ steps.set-nightly-version.outputs.version }} release
+        commit_user_name: Adobe CAI Team
+        commit_user_email: noreply@adobe.com
+        create_branch: true
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ The SDK has been tested on the following operating systems:
  | ------------- | --------------------------------------------------- |
  | `avi`         | `video/msvideo`, `video/avi`, `application-msvideo` |
  | `avif`        | `image/avif`                                        |
- | `c2pa`        | `application/x-c2pa-manifest-store`,                |
+ | `c2pa`        | `application/x-c2pa-manifest-store`                 |
  | `dng`         | `image/x-adobe-dng`                                 |
  | `heic`        | `image/heic`                                        |
  | `heif`        | `image/heif`                                        |
@@ -92,11 +92,31 @@ The `c2pa` crate is distributed under the terms of both the [MIT license](https:
 
 Note that some components and dependent crates are licensed under different terms; please check the license terms for each crate and component for details.
 
-## Release Notes
+## Nightly builds
 
-This section gives a highlight of noteworthy changes
+In most cases, you should depend on this crate as published via [crates.io](https://crates.io/crates/c2pa).
 
-Refer to the [CHANGELOG](https://github.com/contentauth/c2pa-rs/blob/main/CHANGELOG.md) for detailed Git changes
+The Adobe team produces nightly snapshots of this crate via a `nightly` branch, which we use for testing the impact of pending changes to upstream dependencies.
+
+You may wish to use these builds for your own testing ahead of our releases, you may include the SDK via the following `Cargo.toml` entry:
+
+```toml
+c2pa = { git = "https://github.com/contentauth/c2pa-rs.git", branch = "nightly", features = [...]}
+```
+
+Commits in this branch have a modified `sdk/Cargo.toml` entry which includes a version number similar to the following:
+
+```toml
+version = "0.25.3-nightly+2023-08-28-2f33ab3"
+```
+
+Please note that there is no formal support for code from a nightly release, but if you become aware of any issues, we would appreciate a bug report including this version number.
+
+## Release notes
+
+This section gives a highlight of noteworthy changes.
+
+Refer to the [CHANGELOG](https://github.com/contentauth/c2pa-rs/blob/main/CHANGELOG.md) for detailed changes derived from git commit history.
 
 
 ## 0.25.0