generated from AMWA-TV/info-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8255c98
Showing
25 changed files
with
478 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
name: Lint | ||
on: [push, pull_request, workflow_dispatch] | ||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
name: Lint | ||
steps: | ||
- name: Use NMOS Lint | ||
uses: docker://amwa/nmos-lint:latest | ||
env: | ||
GITHUB_BRANCH: ${{ github.ref_name }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
name: Open Issue | ||
on: | ||
issues: | ||
types: | ||
- opened | ||
|
||
jobs: | ||
label_issue: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- env: | ||
GITHUB_TOKEN: ${{ github.token }} | ||
ISSUE_URL: ${{ github.event.issue.html_url }} | ||
run: | | ||
gh issue edit $ISSUE_URL --add-label "triage" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: Render | ||
on: | ||
workflow_dispatch: | ||
|
||
push: | ||
branches: | ||
- main | ||
- 'publish-*' | ||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
name: Build | ||
steps: | ||
- name: Use NMOS Render | ||
uses: docker://amwa/nmos-render:latest | ||
env: | ||
SSH_HOST: ${{ secrets.SSH_HOST }} | ||
SSH_USER: ${{ secrets.SSH_USER }} | ||
SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }} | ||
SSH_KNOWN_HOSTS: ${{ secrets.SSH_KNOWN_HOSTS }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
*# | ||
*.swp | ||
*~ | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
*# | ||
*.swp | ||
*~ | ||
.DS_Store | ||
.scripts/ | ||
node_modules/ | ||
npm-debug.log | ||
package-lock.json | ||
package.json | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#!/bin/bash | ||
|
||
set -o errexit | ||
|
||
git clone --single-branch --branch main https://${GITHUB_TOKEN:+${GITHUB_TOKEN}@}github.com/AMWA-TV/nmos-lint-scripts .scripts | ||
.scripts/install-dependencies.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
#!/bin/bash | ||
|
||
set -o errexit | ||
|
||
rm -rf package.json node_modules/ yarn.lock package-lock.json .scripts/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
-include .scripts/scripts.mk | ||
|
||
.PHONY: build-tools distclean | ||
|
||
build-tools: | ||
.init-scripts/make-build-tools.sh | ||
|
||
distclean: | ||
.init-scripts/make-distclean.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
*# | ||
*.swp | ||
*~ | ||
.DS_Store | ||
.layouts/ | ||
.sass-cache/ | ||
.scripts/ | ||
Gemfile.lock | ||
/_layouts/ | ||
/_includes/ | ||
/assets/ | ||
/_data/ | ||
_site/ | ||
branches/ | ||
index.md | ||
node_modules/ | ||
npm-debug.log | ||
package-lock.json | ||
package.json | ||
releases/ | ||
raml2html-nmos-theme/ | ||
source-repo/ | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#!/bin/bash | ||
|
||
set -o errexit | ||
|
||
git clone --single-branch --branch "${NMOS_DOC_BUILD_SCRIPTS_BRANCH:-main}" https://${GITHUB_TOKEN:+${GITHUB_TOKEN}@}github.com/AMWA-TV/nmos-render-scripts .scripts | ||
.scripts/install-dependencies.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
#!/bin/bash | ||
|
||
set -o errexit | ||
|
||
rm -f index.md index-contents.md | ||
rm -rf source-repo/ branches/ releases/ | ||
rm -rf .scripts/ .layouts/ _layouts/ assets/ raml2html-nmos-theme/ _site/ .ssh/ | ||
rm -rf node_modules/ | ||
rm -f yarn.lock package.json package-lock.json Gemfile.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
source 'https://rubygems.org' | ||
gem 'github-pages', group: :jekyll_plugins | ||
gem 'faraday', '~>0' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
-include .scripts/scripts.mk | ||
|
||
.PHONY: build-tools distclean | ||
|
||
build-tools: | ||
.init-scripts/make-build-tools.sh | ||
|
||
distclean: | ||
.init-scripts/make-distclean.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Don't change these | ||
theme: jekyll-theme-primer | ||
spec_server: specs.amwa.tv | ||
|
||
# AMWA ID | ||
amwa_id: INFO-TEMPLATE | ||
|
||
# Base name for site (typically lower case version of AMWA ID, or the repo name) | ||
baseurl: /info-template | ||
|
||
# Which release or branch appears in header links and on the home page | ||
default_tree: branches/main # alternatively e.g. releases/v1.0 | ||
|
||
# Regex patterns of releases and branches to show | ||
show_releases: | ||
show_branches: main|^publish- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
--- | ||
|
||
{{ site.data.spec | jsonify }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Changelog | ||
This document provides an overview of changes between releases of this document. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributing | ||
|
||
Thanks for your interest in this AMWA NMOS Specification. | ||
|
||
AMWA Specifications (including Best Current Practices) are developed and ratified in accordance with | ||
AMWA's Specification Process. See BCP-001 on the [AMWA Specifications page](https://www.amwa.tv/specifications) | ||
|
||
They are created and updated in AMWA working groups, requiring AMWA membership for participation. | ||
|
||
AMWA member contributions to this Specification are made subject to AMWA's [IPR Policy](https://www.amwa.tv/about/policies/AMWA_IPR_Policy_V3.0.pdf). | ||
Contributions should be accompanied by the form in an appendix of that policy. | ||
|
||
For more information for those wishing to develop or contribute to AMWA NMOS Specifications, | ||
please see the NMOS [Wiki Page](https://github.com/amwa-tv/nmos/wiki/Maintainers) for maintainers. | ||
|
||
## Reporting Issues | ||
|
||
AMWA members and non-members are welcome to raise issues via the GitHub Issues tab. | ||
|
||
## Pull Requests | ||
|
||
We accept Pull Requests from AMWA members participating in relevant workgroups. These are subject to the IPR Policy. | ||
|
||
Please read about our [GitHub Workflow](https://github.com/amwa-tv/nmos/wiki/GitHub-Workflow) before creating a pull request, | ||
in particular the 'Maintaining a Specification' section, as we try to maintain a consistent approach to branches and releases. | ||
This should indicate which branch it is most appropriate to create your pull request against. | ||
|
||
Each NMOS workgroup has a number of members that will review a PR. | ||
|
||
## Suggesting Improvements or Enhancements | ||
|
||
We are interested in hearing of suggestions, both for the spec itself and the accompanying documentation. | ||
Please use the issue tracker or [contact AMWA](https://www.amwa.tv/contact). |
Oops, something went wrong.