Skip to content

Commit 7a26594

Browse files
author
Ryan Faircloth
authored
fix(doc): bump version for new docs site (#87)
1 parent 2b1b512 commit 7a26594

File tree

14 files changed

+937
-13
lines changed

14 files changed

+937
-13
lines changed

‎.github/workflows/cd-docs-pdf.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# ########################################################################
2+
# Copyright 2021 Splunk Inc.
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
# ########################################################################
16+
17+
name: cd-docs-pdf
18+
on:
19+
push:
20+
branches-ignore:
21+
- "**"
22+
tags:
23+
- "v*"
24+
jobs:
25+
release:
26+
name: Release
27+
runs-on: ubuntu-latest
28+
steps:
29+
- uses: actions/checkout@v2
30+
with:
31+
submodules: false
32+
- id: doc-files
33+
name: Produce PDF from docs
34+
run: |
35+
sudo apt-get install -y pandoc texlive librsvg2-bin texlive-latex-extra
36+
pandoc -s --pdf-engine=pdflatex -o /tmp/SC4S_docs.pdf $(find . -type f -name "*.md")
37+
- name: Release
38+
uses: softprops/action-gh-release@v1
39+
with:
40+
files: /tmp/SC4S_docs.pdf

‎.github/workflows/cd-pages.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: cd-pages-helm
2+
3+
on:
4+
push:
5+
branches-ignore:
6+
- "**"
7+
tags:
8+
- "v*"
9+
10+
jobs:
11+
mike:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v2
17+
with:
18+
fetch-depth: 0
19+
- uses: oleksiyrudenko/gha-git-credentials@v2-latest
20+
with:
21+
token: "${{ secrets.GITHUB_TOKEN }}"
22+
- name: Upload
23+
run: |
24+
VERSION=$(echo $GITHUB_REF | cut -d / -f 3 | sed 's/v//')
25+
echo $VERSION
26+
#We only published tagged version for main
27+
if [[ $VERSION != *"develop"* ]]; then
28+
pip3 install poetry
29+
poetry install
30+
poetry run mike deploy -p -u $VERSION latest
31+
fi
32+
# helm:
33+
# runs-on: ubuntu-latest
34+
# needs: mike
35+
# steps:
36+
# - name: Checkout
37+
# uses: actions/checkout@v2
38+
# with:
39+
# fetch-depth: 0
40+
# - name: Install Helm
41+
# uses: azure/setup-helm@v1
42+
# with:
43+
# version: v3.6.3
44+
# - name: Upload
45+
# run: |
46+
# mkdir /tmp/package
47+
# mkdir /tmp/index
48+
# mkdir /tmp/origin
49+
# echo ${{ secrets.GITHUB_TOKEN }} | gh auth login --with-token
50+
# VERSION=$(echo $GITHUB_REF | cut -d / -f 3)
51+
# echo $VERSION
52+
# wget https://splunk.github.io/splunk-connect-for-syslog/index.yaml -P /tmp/origin
53+
# helm package charts/splunk-connect-for-syslog -d /tmp/package
54+
# gh release upload $VERSION /tmp/package/*
55+
# helm repo index /tmp/package --url https://github.com/splunk/splunk-connect-for-syslog/releases/download/$VERSION --merge /tmp/origin/index.yaml
56+
# cp /tmp/package/index.yaml /tmp/index/
57+
# - name: Deploy
58+
# uses: peaceiris/actions-gh-pages@v3
59+
# with:
60+
# github_token: ${{ secrets.GITHUB_TOKEN }}
61+
# publish_dir: /tmp/index
62+
# keep_files: true

‎.github/workflows/ci-main.yaml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# ########################################################################
2+
# Copyright 2021 Splunk Inc.
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
# ########################################################################
16+
17+
name: ci-main
18+
on:
19+
push:
20+
branches:
21+
- "main"
22+
- "develop"
23+
pull_request:
24+
branches:
25+
- "main"
26+
- "develop"
27+
jobs:
28+
release:
29+
name: Release
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v2
33+
with:
34+
submodules: false
35+
persist-credentials: false
36+
- name: Semantic Release
37+
id: version
38+
uses: cycjimmy/[email protected]
39+
with:
40+
semantic_version: 17
41+
extra_plugins: |
42+
@semantic-release/exec
43+
@semantic-release/git
44+
semantic-release-helm
45+
@google/semantic-release-replace-plugin
46+
env:
47+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48+
mike:
49+
runs-on: ubuntu-latest
50+
if: ${{ github.ref == 'refs/heads/develop' }}
51+
steps:
52+
- name: Checkout
53+
uses: actions/checkout@v2
54+
with:
55+
fetch-depth: 0
56+
- uses: oleksiyrudenko/gha-git-credentials@v2-latest
57+
with:
58+
token: "${{ secrets.PAT_CLATOOL }}"
59+
- name: Upload
60+
run: |
61+
BRANCH=$(echo $GITHUB_REF | cut -d / -f 3)
62+
echo $BRANCH
63+
pip3 install poetry
64+
poetry install
65+
poetry run mike deploy -p $BRANCH

‎.github/workflows/review-secrets.yml‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎.github/workflows/update-tags.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Update Semver
2+
on:
3+
push:
4+
branches-ignore:
5+
- "**"
6+
tags:
7+
- "v*.*.*"
8+
jobs:
9+
update-semver:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- uses: haya14busa/action-update-semver@v1

‎docs/.gitignore‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
.vscode/settings.json

0 commit comments

Comments
 (0)