From c830c1ea93d04712718bd88355748a46f564eec9 Mon Sep 17 00:00:00 2001 From: Pierre-Anthony Lemieux Date: Mon, 17 Jun 2024 19:54:13 -0700 Subject: [PATCH] Initial commit --- .github/workflows/main.yml | 68 ++++++++++++++++++++++++++++++++ .gitignore | 18 +++++++++ .gitmodules | 4 ++ .smpte-build.json | 3 ++ CONFIDENTIALITY.md | 4 ++ CONTRIBUTING.md | 10 +++++ LICENSE.md | 4 ++ PATENTS.md | 4 ++ README.md | 14 +++++++ doc/elements/bsd-3-clause.txt | 29 ++++++++++++++ doc/main.html | 73 +++++++++++++++++++++++++++++++++++ tooling | 1 + 12 files changed, 232 insertions(+) create mode 100644 .github/workflows/main.yml create mode 100644 .gitignore create mode 100644 .gitmodules create mode 100644 .smpte-build.json create mode 100644 CONFIDENTIALITY.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 PATENTS.md create mode 100644 README.md create mode 100644 doc/elements/bsd-3-clause.txt create mode 100644 doc/main.html create mode 160000 tooling diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..71f7a29 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,68 @@ +name: Build SMPTE document + +on: + push: + pull_request: + release: + types: [published] + +env: + AWS_REGION: us-east-1 + AWS_S3_BUCKET: html-doc-pub + AWS_ROLE: arn:aws:iam::189079736792:role/gh-actions-html-pub + CANONICAL_LINK_PREFIX: https://doc.smpte-doc.org/ + +jobs: + build: + runs-on: ubuntu-latest + if: > + github.repository_owner == 'SMPTE' && ( + (github.event_name == 'push' && github.ref == 'refs/heads/main') + || github.event_name == 'pull_request' + || github.event_name == 'release' + ) + # These permissions are needed to interact with GitHub's OIDC Token endpoint. + permissions: + id-token: write + contents: write + pull-requests: write + + steps: + + - name: Checkout repo + uses: actions/checkout@v3 + with: + fetch-depth: 0 + submodules: true + + - name: Set repository name + run: echo "REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV + + - name: Check out all branches with the exception of the current branch + run: CUR_BRANCH=$(git rev-parse --abbrev-ref HEAD); for i in `git branch -a | grep remote | grep -v "remotes/pull" | grep -v HEAD | grep -v ${CUR_BRANCH}`; do git branch --track ${i#remotes/origin/} $i; done + + - name: Configure AWS Credentials + uses: aws-actions/configure-aws-credentials@v1-node16 + with: + role-to-assume: ${{ env.AWS_ROLE }} + aws-region: ${{ env.AWS_REGION }} + + - name: Build and deploy document (local) + uses: ./tooling/workflows + if: github.repository != 'SMPTE/html-pub' + with: + AWS_S3_REGION: ${{env.AWS_REGION}} + AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}} + AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/" + CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + + - name: Build and deploy document (HTML Pub repo) + uses: ./workflows + if: github.repository == 'SMPTE/html-pub' + with: + AWS_S3_REGION: ${{env.AWS_REGION}} + AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}} + AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/" + CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1044ecb --- /dev/null +++ b/.gitignore @@ -0,0 +1,18 @@ +# SMPTE HTML Publication artifacts +/build +/package.json +/package-lock.json + +# MacOS +.DS_Store +._* + +# Unix +*~ + +# Windows +Thumbs.db +.vscode + +# npm +/node_modules diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..f9d75a8 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "tooling"] + path = tooling + url = https://github.com/SMPTE/html-pub.git + branch = main diff --git a/.smpte-build.json b/.smpte-build.json new file mode 100644 index 0000000..c46e10f --- /dev/null +++ b/.smpte-build.json @@ -0,0 +1,3 @@ +{ + "latestEditionTag": null +} diff --git a/CONFIDENTIALITY.md b/CONFIDENTIALITY.md new file mode 100644 index 0000000..fbe9883 --- /dev/null +++ b/CONFIDENTIALITY.md @@ -0,0 +1,4 @@ +# CONFIDENTIALITY + +This repository is not SMPTE Confidential Information and is not subject to the +confidentiality policy specified by the SMPTE Standards Operations Manual. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8d1ba1d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# CONTRIBUTING + +Please be aware that all contributions to this material are being conducted in accordance with the SMPTE Standards Operations +Manual, which is accessible on the SMPTE website with the Society Bylaws: https://www.smpte.org/about/policies-and-governance. + +Your comments and contributions, whether as a member or guest, are governed by these provisions and any comment or contribution made +by you indicates your acknowledgement that you understand and are complying with the full form of the Operations Manual. Please take +careful note of the sections requiring contributors to inform the Committee of personal knowledge of any claims under any issued +patent or any patent application that likely would be infringed by an implementation of this material. This general reminder is not +a substitute for a contributor’s responsibility to fully read, understand, and comply with the full Standards Operations Manual. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..0e1f479 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,4 @@ +# LICENSE + +Copyright © by the Society of Motion Picture and Television Engineers. All rights reserved. No part of this material may be +reproduced, by any means whatsoever, without the prior written permission of the Society of Motion Picture and Television Engineers. diff --git a/PATENTS.md b/PATENTS.md new file mode 100644 index 0000000..c4a6260 --- /dev/null +++ b/PATENTS.md @@ -0,0 +1,4 @@ +# PATENTS + +Attention is drawn to the possibility that some of the elements of this material may be the subject of patent rights. SMPTE shall +not be held responsible for identifying any or all such patent rights. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9628663 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# SMPTE AG 28 + +_This repository is *public*._ + +* [Latest version](https://doc.smpte-doc.org/ag28/main/) +* [Latest version (all artifacts)](https://doc.smpte-doc.org/ag28/main/pub-artifacts.html) + +Please consult [CONTRIBUTING.md](./CONTRIBUTING.md), [CONFIDENTIALITY.md](./CONFIDENTIALITY.md), [LICENSE.md](./LICENSE.md) and +[PATENTS.md](./PATENTS.md) for important notices. + +## Reporting issues + +Issues should be reported at . + diff --git a/doc/elements/bsd-3-clause.txt b/doc/elements/bsd-3-clause.txt new file mode 100644 index 0000000..0f5a70f --- /dev/null +++ b/doc/elements/bsd-3-clause.txt @@ -0,0 +1,29 @@ +Copyright +Copyright +... +Copyright + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this +list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, +this list of conditions and the following disclaimer in the documentation and/or +other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors +may be used to endorse or promote products derived from this software without +specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 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. \ No newline at end of file diff --git a/doc/main.html b/doc/main.html new file mode 100644 index 0000000..27a786e --- /dev/null +++ b/doc/main.html @@ -0,0 +1,73 @@ + + + + + + + + + + + + Software license + + + +
+

Software is commonly used in Engineering Documents and + Registered Disclosure Documents. It can, for example, provide a sample + implementation of an algorithm or carry large amounts of machine-readable + data.

+ +

By making the software available under a permissive copyright + license, its use in implementations, both commercial and open-source, + is facilitated, and interoperability is therefore enhanced.

+
+ +
+

This document specifies the copyright license for software that + is part of Engineering Documents and Registered Disclosure Documents.

+
+ +
+ +
+
software
+ +
programs, procedures, rules, data, tests and associated + documentation pertaining to the operation of a computer system
+
+
+ +
+

License

+ +

Wherever its location, all software that is part of an + Engineering Document or Registered Document is licensed under the terms of + 3-clause BSD license, specified in . The + Engineering Document or Registered Document may be in any stage of + development or published.

+ +

Software may contain components that were developed outside the + Standards Community if and only if such components are also licensed under + the terms of the 3-clause BSD license.

+ +

The copyright notice of shall be present in + every file or document that contains the software.

+ +

The Society of Motion Picture and Television Engineers shall be + the sole copyright holder listed in the notice unless the software + contain components that were developed outside the Standards Community, in + which case the copyright owners listed for those components shall also be + included.

+
+ +
+
    +
    2. +
+
+ + + \ No newline at end of file diff --git a/tooling b/tooling new file mode 160000 index 0000000..410fc3e --- /dev/null +++ b/tooling @@ -0,0 +1 @@ +Subproject commit 410fc3e35addd065782324e08a13353e5fc7f6b1