Skip to content

Commit

Permalink
Inital commit
Browse files Browse the repository at this point in the history
  • Loading branch information
aforsythe committed May 27, 2024
0 parents commit 8a5d3f9
Show file tree
Hide file tree
Showing 11 changed files with 200 additions and 0 deletions.
70 changes: 70 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Create Release with Submodules

on:
push:
tags:
- 'v*.*.*' # Trigger the workflow on new version tags

permissions:
contents: write # Ensure the workflow has permission to write contents
packages: write # Ensure the workflow has permission to upload packages

jobs:
create-release:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: true # Checkout submodules

- name: Set up Git
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
- name: Sanitize Tag Name
id: sanitize_tag
run: |
TAG_NAME=${GITHUB_REF##*/}
if [[ "$TAG_NAME" == v* ]]; then
# Replace characters that are not allowed in filenames
SAFE_TAG_NAME=$(echo $TAG_NAME | tr '+./' '-')
echo "SAFE_TAG_NAME=$SAFE_TAG_NAME" >> $GITHUB_ENV
else
echo "This tag does not match the expected pattern." >&2
exit 1
fi
- name: Create release archives
run: |
mkdir -p /tmp/release_temp
rsync -a --exclude='.git' ./ /tmp/release_temp/
cd /tmp/release_temp
tar -czf /tmp/aces_${{ env.SAFE_TAG_NAME }}.tar.gz .
zip -r /tmp/aces_${{ env.SAFE_TAG_NAME }}.zip .
- name: Upload release assets
uses: actions/upload-artifact@v4
with:
name: release-artifacts
path: |
/tmp/aces_${{ env.SAFE_TAG_NAME }}.tar.gz
/tmp/aces_${{ env.SAFE_TAG_NAME }}.zip
- name: Create GitHub Release
id: create_release
uses: softprops/action-gh-release@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
name: ${{ github.ref_name }}
body: |
Release with submodules included.
draft: false
prerelease: false
files: |
/tmp/aces_${{ env.SAFE_TAG_NAME }}.tar.gz
/tmp/aces_${{ env.SAFE_TAG_NAME }}.zip
15 changes: 15 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[submodule "aces-core"]
path = aces-core
url = git@github.com:ampas/aces-dev.git
[submodule "aces-look"]
path = aces-look
url = git@github.com:ampas/aces-look.git
[submodule "aces-amf"]
path = aces-amf
url = git@github.com:ampas/aces-amf.git
[submodule "aces-output"]
path = aces-output
url = git@github.com:ampas/aces-output.git
[submodule "aces-input-and-colorspaces"]
path = aces-input-and-colorspaces
url = git@github.com:ampas/aces-input-and-colorspaces.git
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to ACES

We're thrilled that you're interested in contributing to ACES. To maintain the legal integrity of the project's codebase, we require all contributors to sign a Contributor License Agreement (CLA).

## Signing the CLA

- Before we can merge any of your contributions, you must sign our CLA.
- The process is simple. When you submit a pull request for the first time, you will be prompted to sign the CLA online.
- If you are contributing on behalf of your employer or if your contributions are owned by someone other than yourself (e.g., your employer), please make sure you have the right to submit the contributions under our project's CLA.

By signing the CLA, you assure the project and its users that your contributions do not infringe upon the rights of any third parties and that the project can use your contributions without legal repercussions.

If you have any questions about the CLA process, please feel free to contact a member of the ACES Team via ACESCentral.com.

## Requirement for Signed Commits

As part of our commitment to security and the integrity of our codebase, we require all commits to be signed. This helps us ensure that contributions are actually made by the account they come from and not altered by a third party.

### Why Signed Commits?

Signed commits provide an additional layer of security by guaranteeing that the commits are from a verified source. This is crucial for maintaining the trustworthiness of our codebase.

### How to Sign Commits

To sign commits, you'll need to use a GPG (GNU Privacy Guard) or S/MIME (Secure/Multipurpose Internet Mail Extensions) key. If you haven't already set up a GPG key, you can follow [GitHub's guide on generating a new GPG key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key).

Once you have a GPG key, you can add it to your GitHub account. For instructions on how to do this, see [GitHub's documentation on adding a new GPG key to your account](https://docs.github.com/en/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account).

When you have your GPG key added to your GitHub account, you can start signing your commits. If you're using the command line, you can sign commits with `git commit -S -m "Your commit message"`.

### Verifying a Signed Commit

You can verify that your commits are signed by looking for the "Verified" label on GitHub's commit interface.

### What if You Cannot Sign Your Commits?

We understand that in some scenarios, you might not be able to sign commits. If you find yourself in this situation, please reach out to the project maintainers for assistance.

For more detailed instructions on signing commits, you can refer to [GitHub's documentation on signing commits](https://docs.github.com/en/github/authenticating-to-github/signing-commits).

---

We appreciate your contributions to ACES, and we thank you for adhering to our signed commits policy. This policy helps us maintain the security and integrity of our codebase.

If you have any questions about this process, please feel free to contact the project maintainers.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# License Terms for Academy Color Encoding System Components

Academy Color Encoding System (ACES) software and tools are provided by the Academy under the following terms and conditions: A worldwide, royalty-free, non-exclusive right to copy, modify, create derivatives, and use, in source and binary forms, is hereby granted, subject to acceptance of this license.

Copyright 2024 Academy of Motion Picture Arts and Sciences (A.M.P.A.S.). Portions contributed by others as indicated. All rights reserved.

Performance of any of the aforementioned acts indicates acceptance to be bound by the following terms and conditions:

> Copies of source code, in whole or in part, must retain the above copyright notice, this list of conditions and the Disclaimer of Warranty.
>
> Use in binary form must retain the above copyright notice, this list of conditions and the Disclaimer of Warranty in the documentation and/or other materials provided with the distribution.
>
> Nothing in this license shall be deemed to grant any rights to trademarks, copyrights, patents, trade secrets or any other intellectual property of A.M.P.A.S. or any contributors, except as expressly stated herein.
>
> Neither the name "A.M.P.A.S." nor the name of any other contributors to this software may be used to endorse or promote products derivative of or based on this software without express prior written permission of A.M.P.A.S. or the contributors, as appropriate.
This license shall be construed pursuant to the laws of the State of California, and any disputes related thereto shall be subject to the jurisdiction of the courts therein.

Disclaimer of Warranty: THIS SOFTWARE IS PROVIDED BY A.M.P.A.S. AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL A.M.P.A.S., OR ANY CONTRIBUTORS OR DISTRIBUTORS, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, RESITUTIONARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE ACADEMY SPECIFICALLY DISCLAIMS ANY REPRESENTATIONS OR WARRANTIES WHATSOEVER RELATED TO PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS IN THE ACADEMY COLOR ENCODING SYSTEM, OR APPLICATIONS THEREOF, HELD BY PARTIES OTHER THAN A.M.P.A.S.,WHETHER DISCLOSED OR UNDISCLOSED.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Academy Color Encoding System #

This repository contains submodules to the component repositories of the Academy Color Encoding System (ACES). It serves as a convenient way to manage and reference various versions of ACES.

### Versioning

ACES uses [semantic versioning](https://semver.org/). The version number of ACES reflects changes to the [ACES core algorithms](https://github.com/ampas/aces-dev). Additionally, this repository includes a build number that denotes the specific collection of modular components (e.g., [Input and Color Space Transforms](https://github.com/ampas/aces-input-and-colorspaces), [Output Transforms](https://github.com/ampas/aces-output), etc.).

#### Semantic Versioning Structure

- **MAJOR.MINOR.PATCH**: Reflects changes to the core ACES algorithms.
- **Build Number**: Identifies the specific collection of modular components provided by the ACES team, as well as other contributions from the community.

### Modular Components

The modular components of ACES can be updated at any time by the ACES team or by end users. These components do not affect the core functionality of ACES, which is why they are not included in the MAJOR.MINOR.PATCH version number.

### Contributions and Customization

Developers and end users may generate their own modular components. When doing so, they should:

- Create an ACES `transformID` for their components.
- Provide a mechanism for sharing these components with other users (e.g via a CLF referenced in an AMF file).

End users and developers are not required to share their modular components with the community, which allows for extensive customization while preserving the core integrity of the ACES system. For instance, a developer might create custom look transforms or color space conversion transforms for a specific project. While they may choose not to share these with the wider community, they should still create an ACES transformID and CLF files to facilitate sharing these transforms with other vendors involved in the same project.

Note: Sharing custom transforms may necessitate that the software used on the project supports reading CLF and AMF files and can correctly apply these custom transforms within the ACES pipeline.

### Summary

This repository provides a structured and organized way to track and manage different versions of ACES, along with their associated modular components. The build number helps developers reference a specific set of components, while also allowing for the addition of custom components.


## License ##
This project is licensed under the terms of the [LICENSE](./LICENSE.md) agreement.

## Contributing ##
Thank you for your interest in contributing to our project. Before any contributions can be accepted, we require contributors to sign a Contributor License Agreement (CLA) to ensure that the project can freely use your contributions. You can find more details and instructions on how to sign the CLA in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

## Support ##
For support, please visit [ACESCentral.com](https://acescentral.com)
3 changes: 3 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Support

For support, please visit [ACESCentral.com](https://acescentral.com)
1 change: 1 addition & 0 deletions aces-amf
Submodule aces-amf added at 95a270
1 change: 1 addition & 0 deletions aces-core
Submodule aces-core added at 0b632d
1 change: 1 addition & 0 deletions aces-input-and-colorspaces
1 change: 1 addition & 0 deletions aces-look
Submodule aces-look added at 48ccda
1 change: 1 addition & 0 deletions aces-output
Submodule aces-output added at e22e58

0 comments on commit 8a5d3f9

Please sign in to comment.