Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
palemieux committed Jun 18, 2024
0 parents commit c830c1e
Show file tree
Hide file tree
Showing 12 changed files with 232 additions and 0 deletions.
68 changes: 68 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -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}}
18 changes: 18 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "tooling"]
path = tooling
url = https://github.com/SMPTE/html-pub.git
branch = main
3 changes: 3 additions & 0 deletions .smpte-build.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"latestEditionTag": null
}
4 changes: 4 additions & 0 deletions CONFIDENTIALITY.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions PATENTS.md
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/SMPTE/ag28/issues>.

29 changes: 29 additions & 0 deletions doc/elements/bsd-3-clause.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Copyright <YEAR> <COPYRIGHT HOLDER #1>
Copyright <YEAR> <COPYRIGHT HOLDER #2>
...
Copyright <YEAR> <COPYRIGHT HOLDER #3>

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.
73 changes: 73 additions & 0 deletions doc/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!doctype html>
<html>
<head itemscope="itemscope" itemtype="http://smpte.org/standards/documents">
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<script type="module" src="../tooling/smpte.js"></script>
<meta itemprop="pubType" content="AG" />
<meta itemprop="pubNumber" content="28" />
<meta itemprop="pubState" content="draft" />
<meta itemprop="pubDateTime" content="2099-01-01" />
<title>Software license</title>
</head>
<body>

<section id="sec-introduction">
<p><a>Software</a> 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.</p>

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

<section id="sec-scope">
<p>This document specifies the copyright license for <a>software</a> that
is part of Engineering Documents and Registered Disclosure Documents.</p>
</section>

<section id="sec-terms-and-definitions">

<dl id="terms-int-defs">
<dt><dfn>software</dfn></dt>

<dd>programs, procedures, rules, data, tests and associated
documentation pertaining to the operation of a computer system</dd>
</dl>
</section>

<section id="sec-license">
<h2>License</h2>

<p>Wherever its location, all <a>software</a> that is part of an
Engineering Document or Registered Document is licensed under the terms of
3-clause BSD license, specified in <a href="#element-a"></a>. The
Engineering Document or Registered Document may be in any stage of
development or published.</p>

<p><a>Software</a> 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.</p>

<p>The copyright notice of <a href="#element-a"></a> shall be present in
every file or document that contains the software.</p>

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

<section id="sec-elements">
<ol>
<li><a id="element-a" title="BSD 3-Clause License"
href="elements/bsd-3-clause.txt"></a></li>
</ol>
</section>

</body>
</html>
1 change: 1 addition & 0 deletions tooling
Submodule tooling added at 410fc3

0 comments on commit c830c1e

Please sign in to comment.