generated from EclipseFdn/.eclipsefdn-template
-
Notifications
You must be signed in to change notification settings - Fork 1
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 14d0bc5
Showing
12 changed files
with
321 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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 @@ | ||
# The releng team is by default the owner of everything. | ||
* @{{ org }}/eclipsefdn-releng | ||
|
||
# Otterdog related configurations are also owned by the security team. | ||
/otterdog/** @{{ org }}/eclipsefdn-security |
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,13 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: github-actions | ||
directory: "/" | ||
# We scan and create dependabot PRs against the develop branch only. | ||
# Such a branch only exists for the template master at EclipseFdn/.eclipsefdn-template | ||
# dependabot shall only update the template master, and changes will be synchronized to | ||
# all repos by otterdog using the sync-template operation to avoid having many similar | ||
# dependabot PRs for each individual .eclipsefdn repo which we would like to avoid at all costs. | ||
target-branch: "develop" | ||
schedule: | ||
interval: daily | ||
open-pull-requests-limit: 10 |
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,118 @@ | ||
name: Build GH Page | ||
|
||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- 'main' | ||
paths: | ||
- 'otterdog/*.jsonnet' | ||
- 'docs/**' | ||
- 'mkdocs.yml' | ||
- '.github/workflows/build-page.yml' | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
jobs: | ||
generate-markdown: | ||
# do not run the workflow in the template repo itself | ||
if: ${{ !contains (github.repository, '/.eclipsefdn-template') }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout eclipse-csi/otterdog | ||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
with: | ||
repository: eclipse-csi/otterdog | ||
path: otterdog | ||
|
||
- name: Checkout EclipseFdn/otterdog-configs | ||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
with: | ||
repository: EclipseFdn/otterdog-configs | ||
path: otterdog-configs | ||
|
||
# checkout the HEAD ref | ||
- name: Checkout HEAD | ||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
with: | ||
path: ${{ github.repository_owner }} | ||
|
||
- name: Install jsonnet-bundler | ||
run: | | ||
go install -a github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@v0.5.1 | ||
echo $(go env GOPATH)/bin >> $GITHUB_PATH | ||
- name: Install poetry | ||
run: pipx install poetry | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0 | ||
with: | ||
python-version: '3.10' | ||
cache: 'poetry' | ||
|
||
- name: Install dependencies with poetry | ||
run: | | ||
poetry install --only=main | ||
working-directory: otterdog | ||
|
||
- name: Copy configuration from HEAD ref | ||
run: | | ||
mkdir -p orgs/${{ github.repository_owner }} | ||
cp -r ../${{ github.repository_owner }}/otterdog/* orgs/${{ github.repository_owner }} | ||
working-directory: otterdog-configs | ||
|
||
- name: Generate default configuration as markdown | ||
run: ../otterdog/otterdog.sh show-default ${{ github.repository_owner }} -c otterdog.json --markdown > default.txt | ||
working-directory: otterdog-configs | ||
|
||
- name: Upload generated site content | ||
uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 | ||
with: | ||
name: generated-site | ||
path: | | ||
otterdog-configs/default.txt | ||
otterdog-configs/orgs/${{ github.repository_owner }}/vendor/otterdog-defaults/*.libsonnet | ||
build-page: | ||
runs-on: ubuntu-latest | ||
needs: generate-markdown | ||
steps: | ||
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
- name: Download generated site content | ||
uses: actions/download-artifact@eaceaf801fd36c7dee90939fad912460b18a1ffe # v4.1.2 | ||
with: | ||
name: generated-site | ||
- shell: bash | ||
run: | | ||
cat default.txt >> ./docs/playground.md | ||
cp orgs/${{ github.repository_owner }}/vendor/otterdog-defaults/*.libsonnet ./docs/jsonnet/ | ||
- uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0 | ||
with: | ||
python-version: 3.x | ||
cache: 'pip' | ||
- run: pip install -r requirements.txt | ||
- name: Build with Mkdocs | ||
run: mkdocs build | ||
- name: Setup Pages | ||
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0 | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 | ||
|
||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build-page | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@decdde0ac072f6dcbe43649d82d9c635fff5b4e4 # v4.0.4 |
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,7 @@ | ||
# Eclipse Foundation Config Repo | ||
|
||
Repository to host configurations related to the Eclipse Foundation. | ||
|
||
## Self service of your GitHub organization | ||
|
||
You can find more information at <https://{{ org }}.github.io/.eclipsefdn/>. |
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,17 @@ | ||
--- | ||
hide: | ||
- navigation | ||
- toc | ||
--- | ||
|
||
# Self-service of GitHub resources | ||
|
||
General documentation for using the self-service (stored in directory *otterdog*) can be accessed at [otterdog.readthedocs.io](https://otterdog.readthedocs.io). | ||
|
||
## Current configuration | ||
|
||
The current configuration can be reviewed in the [Otterdog Dashboard](https://otterdog.eclipse.org/organizations/{{ org_id }}). | ||
|
||
## Playground | ||
|
||
A playground for creating and testing resources in jsonnet format is available [here](playground.md). |
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 @@ | ||
local orgs = import 'otterdog-defaults.libsonnet'; | ||
|
||
orgs.newRepo('myrepo') |
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,44 @@ | ||
{% extends "base.html" %} | ||
|
||
{% block libs %} | ||
{{ super() }} | ||
<script src="https://eclipsefdn.github.io/otterdog-assets/third_party/js-yaml/dist/js-yaml.min.js"></script> | ||
<script src="https://eclipsefdn.github.io/otterdog-assets/third_party/CodeMirror/lib/codemirror.js"></script> | ||
<script src="https://eclipsefdn.github.io/otterdog-assets/third_party/CodeMirror/mode/yaml/yaml.js"></script> | ||
<script src="https://eclipsefdn.github.io/otterdog-assets/third_party/CodeMirror/addon/edit/matchbrackets.js"></script> | ||
<script src="https://eclipsefdn.github.io/otterdog-assets/js/codemirror-mode-jsonnet.js"></script> | ||
|
||
<!-- Executing Jsonnet --> | ||
<script src="https://eclipsefdn.github.io/otterdog-assets/js/wasm_exec.js"></script> | ||
<script> | ||
if (!WebAssembly.instantiateStreaming) { | ||
// This function was observed to be missing on Safari 14. | ||
WebAssembly.instantiateStreaming = async (resp, importObject) => { | ||
const source = await (await resp).arrayBuffer(); | ||
return await WebAssembly.instantiate(source, importObject); | ||
}; | ||
} | ||
const go = new Go(); | ||
WebAssembly.instantiateStreaming(fetch("https://eclipsefdn.github.io/otterdog-assets/js/libjsonnet.wasm"), go.importObject).then((result) => { | ||
go.run(result.instance); | ||
}); | ||
</script> | ||
<script src="https://eclipsefdn.github.io/otterdog-assets/js/demo.js"></script> | ||
{% endblock %} | ||
|
||
{% block styles %} | ||
<!-- Google Fonts --> | ||
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400italic,600italic,700italic,400,600,700" rel="stylesheet" type="text/css"> | ||
|
||
<!-- jsonnet.org stylesheet --> | ||
<link rel="stylesheet" type="text/css" href="https://eclipsefdn.github.io/otterdog-assets/css/doc.css" /> | ||
<link rel="stylesheet" media="print" href="https://eclipsefdn.github.io/otterdog-assets/css/desktop.css"> | ||
<!-- The extra 16px is to account for the scrollbar, which is not always included. --> | ||
<link rel="stylesheet" media="screen and (min-width: 1296px)" href="https://eclipsefdn.github.io/otterdog-assets/css/desktop.css"> | ||
<link rel="stylesheet" media="screen and (max-width: 1295px) and (min-width: 720px)" href="https://eclipsefdn.github.io/otterdog-assets/css/cellphone.css"> | ||
<link rel="stylesheet" media="screen and (max-width: 719px)" href="https://eclipsefdn.github.io/otterdog-assets/css/cellphone-small.css"> | ||
{{ super() }} | ||
|
||
<!-- CodeMirror --> | ||
<link rel="stylesheet" href="https://eclipsefdn.github.io/otterdog-assets/third_party/CodeMirror/lib/codemirror.css"> | ||
{% endblock %} |
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 @@ | ||
{% extends "base.html" %} | ||
|
||
{% block site_meta %} | ||
{{ super() }} | ||
<!-- prevent caching --> | ||
<meta http-equiv="cache-control" content="no-cache, must-revalidate, post-check=0, pre-check=0" /> | ||
<meta http-equiv="cache-control" content="max-age=0" /> | ||
<meta http-equiv="expires" content="0" /> | ||
<meta http-equiv="expires" content="Tue, 01 Jan 1980 1:00:00 GMT" /> | ||
<meta http-equiv="pragma" content="no-cache" /> | ||
{% endblock %} |
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,56 @@ | ||
--- | ||
template: editor.html | ||
hide: | ||
- navigation | ||
- toc | ||
--- | ||
|
||
# Playground | ||
|
||
You can use the playground below to create and evaluate resource snippets to include in your jsonnet configuration: | ||
|
||
<div class="inverse hgroup"> | ||
<div class=hgroup-inline> | ||
<div class="tab-window-input" id="input"> | ||
<div class="tab-header"> | ||
</div> | ||
<textarea id=playground-jsonnet> | ||
{% include 'jsonnet/playground.jsonnet' %} | ||
</textarea> | ||
<textarea id=otterdog-defaults-libsonnet> | ||
{% include 'jsonnet/otterdog-defaults.libsonnet' %} | ||
</textarea> | ||
<textarea id=otterdog-functions-libsonnet> | ||
{% include 'jsonnet/otterdog-functions.libsonnet' %} | ||
</textarea> | ||
</div> | ||
<div class="bigarrow">➡</div> | ||
<div class="tab-window-output" id="output"> | ||
<div class="tab-header"> | ||
<div class=selected onclick="tab_output_click(this, 'json-output')">output.json</div> | ||
</div> | ||
<textarea readonly class="selected code-json" id="json-output"> | ||
</textarea> | ||
</div> | ||
<script> | ||
demo( | ||
'input', | ||
{ | ||
'playground-jsonnet': 'playground.jsonnet', | ||
'otterdog-defaults-libsonnet': 'otterdog-defaults.libsonnet', | ||
'otterdog-functions-libsonnet': 'otterdog-functions.libsonnet' | ||
}, | ||
'playground.jsonnet', | ||
'output', | ||
false, | ||
false | ||
); | ||
</script> | ||
<div style="clear: both"></div> | ||
</div> | ||
</div> | ||
|
||
## Resource functions and default values | ||
|
||
The following snippets illustrate the functions to create the supported resources with default values as defined in the | ||
[default configuration](https://github.com/EclipseFdn/otterdog-defaults/blob/main/otterdog-defaults.libsonnet) used at the Eclipse Foundation. |
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 @@ | ||
.md-grid { | ||
max-width: 1440px; | ||
} |
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,41 @@ | ||
site_name: Otterdog configuration @ {{ org }} | ||
site_description: Otterdog configuration @ {{ org }} | ||
strict: false | ||
|
||
site_url: https://{{ org }}.github.io/.eclipsefdn/ | ||
|
||
repo_name: {{ org }}/.eclipsefdn | ||
repo_url: https://github.com/{{ org }}/.eclipsefdn/ | ||
|
||
docs_dir: ./docs | ||
site_dir: ./_site | ||
|
||
theme: | ||
name: 'material' | ||
custom_dir: docs/overrides | ||
features: | ||
- navigation.tabs | ||
|
||
markdown_extensions: | ||
- pymdownx.superfences | ||
- pymdownx.tabbed: | ||
alternate_style: true | ||
- attr_list | ||
- pymdownx.emoji: | ||
emoji_index: !!python/name:materialx.emoji.twemoji | ||
emoji_generator: !!python/name:materialx.emoji.to_svg | ||
|
||
plugins: | ||
- macros | ||
|
||
nav: | ||
- Overview: index.md | ||
- playground.md | ||
|
||
watch: [] | ||
|
||
extra: | ||
org_id: {{ org }} | ||
|
||
extra_css: | ||
- stylesheets/extra.css |
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 @@ | ||
mkdocs ~= 1.5 | ||
mkdocs-material ~= 9.4 | ||
mkdocs-macros-plugin ~= 1.0 |