Fix website build and 0.8.x pages, move deploy to workflow and nixify the website part (#982)
This commit is contained in:
parent
cee202004d
commit
4f03cefda0
|
|
@ -1,4 +1,4 @@
|
||||||
name: codespell
|
name: CI Lint
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
|
|
@ -8,14 +8,26 @@ on:
|
||||||
types: [opened, synchronize, ready_for_review, reopened]
|
types: [opened, synchronize, ready_for_review, reopened]
|
||||||
jobs:
|
jobs:
|
||||||
codespell:
|
codespell:
|
||||||
name: codespell
|
name: Codespell
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- name: Codespell
|
- name: Codespell
|
||||||
uses: codespell-project/actions-codespell@v2
|
uses: codespell-project/actions-codespell@v2
|
||||||
with:
|
with:
|
||||||
check_filenames: true
|
check_filenames: true
|
||||||
ignore_words_list: aks,ags,startin
|
ignore_words_list: aks,ags,startin
|
||||||
skip: "*.js,package-lock.json,*.lock,*/Font-Awesome/*,*.toml,*.svg,*assets/vendor/bootstrap*,cert-manager.crds.yaml"
|
skip: "*.js,package-lock.json,*.lock,*/Font-Awesome/*,*.toml,*.svg,*assets/vendor/bootstrap*,cert-manager.crds.yaml"
|
||||||
|
pre-commit:
|
||||||
|
name: PreCommit
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/setup-python@v5.0.0
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- id: files
|
||||||
|
uses: tj-actions/changed-files@v42
|
||||||
|
- uses: pre-commit/action@v3.0.1
|
||||||
|
with:
|
||||||
|
extra_args: --files ${{ steps.files.outputs.all_changed_files }} --show-diff-on-failure
|
||||||
|
|
|
||||||
|
|
@ -1,86 +1,105 @@
|
||||||
name: auto-generate-docs
|
name: Website
|
||||||
|
|
||||||
# Run this workflow every time a new commit pushed to your repository
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
- main
|
- main
|
||||||
paths:
|
paths:
|
||||||
- 'docs/**'
|
- 'website/**'
|
||||||
|
- 'assets/**'
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize, ready_for_review, reopened]
|
||||||
|
paths:
|
||||||
- 'website/**'
|
- 'website/**'
|
||||||
- 'assets/**'
|
- 'assets/**'
|
||||||
|
|
||||||
jobs:
|
permissions:
|
||||||
# Set the job key. The key is displayed as the job name
|
contents: read
|
||||||
# when a job name is not provided
|
pages: write
|
||||||
docs:
|
id-token: write
|
||||||
# Name the Job
|
|
||||||
name: auto-generate-docs
|
|
||||||
# Set the type of machine to run on
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: "website"
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update-date:
|
||||||
|
name: Auto update dates
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.event_name == 'pull_request' || (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
|
||||||
steps:
|
steps:
|
||||||
# Checks out a copy of your repository on the ubuntu-latest machine
|
- uses: DeterminateSystems/nix-installer-action@v9
|
||||||
|
with:
|
||||||
|
diagnostic-endpoint: ""
|
||||||
|
- uses: DeterminateSystems/magic-nix-cache-action@v3
|
||||||
|
with:
|
||||||
|
diagnostic-endpoint: ""
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
|
||||||
submodules: recursive # Fetch the Docsy theme
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
# Checks if the previous commit introduced any changes to website files
|
|
||||||
- name: Check for changes
|
- name: Check for changes
|
||||||
run: |
|
run: |
|
||||||
IS_CHANGED=$(git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -Ec "^website*" || :)
|
IS_CHANGED=$(git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -Ec "^website*" || :)
|
||||||
[[ $IS_CHANGED -gt 0 ]] && echo "IS_CHANGED=true" >> $GITHUB_ENV || echo "IS_CHANGED=false" >> $GITHUB_ENV
|
[[ $IS_CHANGED -gt 0 ]] && echo "IS_CHANGED=true" >> $GITHUB_ENV || echo "IS_CHANGED=false" >> $GITHUB_ENV
|
||||||
|
|
||||||
# Sets up the appropriate version of Hugo
|
|
||||||
- name: Setup Hugo
|
|
||||||
if: env.IS_CHANGED == 'true'
|
|
||||||
uses: peaceiris/actions-hugo@v2
|
|
||||||
with:
|
|
||||||
hugo-version: '0.113.0'
|
|
||||||
extended: true
|
|
||||||
|
|
||||||
# Sets up node - required by Hugo
|
|
||||||
- name: Setup Node
|
|
||||||
if: env.IS_CHANGED == 'true'
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: '12.x'
|
|
||||||
|
|
||||||
# Installs dependencies required by docsy theme
|
|
||||||
- name: Install docsy dependencies
|
|
||||||
if: env.IS_CHANGED == 'true'
|
|
||||||
run: |
|
|
||||||
cd website
|
|
||||||
npm install
|
|
||||||
npm build
|
|
||||||
sudo npm install -D --save autoprefixer
|
|
||||||
sudo npm install -D --save postcss-cli
|
|
||||||
cd ../
|
|
||||||
|
|
||||||
- name: Update last modified date in modified docs
|
- name: Update last modified date in modified docs
|
||||||
if: env.IS_CHANGED == 'true'
|
if: env.IS_CHANGED == 'true'
|
||||||
run: |
|
run: |
|
||||||
git diff --name-only --diff-filter=d ${{ github.event.before }} ${{ github.sha }} | grep -E "^website*" \
|
git diff --name-only --diff-filter=d ${{ github.event.before }} ${{ github.sha }} | grep -E "^website*" \
|
||||||
| sed -e 's/\(.*\)/"\1"/' | xargs sed -i "/date:/c\date: $(date +'%Y-%m-%d')"
|
| sed -e 's/\(.*\)/"\1"/' | xargs sed -i "/date:/c\date: $(date +'%Y-%m-%d')"
|
||||||
|
|
||||||
# Runs makefile goal - checks changes to /website folder and generates docs
|
|
||||||
- name: Run Makefile goal
|
|
||||||
if: env.IS_CHANGED == 'true'
|
|
||||||
env:
|
|
||||||
DEFAULT_BRANCH: master
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: make generate-docs
|
|
||||||
|
|
||||||
# Creates pull request with generated docs
|
|
||||||
- name: Create Pull Request
|
- name: Create Pull Request
|
||||||
if: env.IS_CHANGED == 'true'
|
|
||||||
uses: peter-evans/create-pull-request@v6
|
uses: peter-evans/create-pull-request@v6
|
||||||
|
if: env.IS_CHANGED == 'true' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
|
||||||
with:
|
with:
|
||||||
commit-message: Auto-updated docs
|
commit-message: Auto-updated docs
|
||||||
branch: docs-generator
|
branch: docs-generator
|
||||||
title: Auto-generated docs update
|
title: Auto-generated docs update
|
||||||
body: |
|
body: |
|
||||||
Auto generated docs from master commit ${{ github.sha }}
|
Auto generated docs from master commit ${{ github.sha }}
|
||||||
|
|
||||||
|
website-generate:
|
||||||
|
name: Auto generate website
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.event_name == 'pull_request' || (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
|
||||||
|
steps:
|
||||||
|
- uses: DeterminateSystems/nix-installer-action@v9
|
||||||
|
with:
|
||||||
|
diagnostic-endpoint: ""
|
||||||
|
- uses: DeterminateSystems/magic-nix-cache-action@v3
|
||||||
|
with:
|
||||||
|
diagnostic-endpoint: ""
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: nix checks
|
||||||
|
run: nix flake check
|
||||||
|
- name: nix build
|
||||||
|
env:
|
||||||
|
HUGO_ENVIRONMENT: production
|
||||||
|
HUGO_ENV: production
|
||||||
|
run: nix build .#website
|
||||||
|
- name: Setup Pages
|
||||||
|
id: pages
|
||||||
|
uses: actions/configure-pages@v4
|
||||||
|
- name: Upload artifact
|
||||||
|
uses: actions/upload-pages-artifact@v3
|
||||||
|
with:
|
||||||
|
path: ./result
|
||||||
|
|
||||||
|
website-deploy:
|
||||||
|
name: Deploy website
|
||||||
|
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
|
||||||
|
environment:
|
||||||
|
name: github-pages
|
||||||
|
url: ${{ steps.deployment.outputs.page_url }}
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: website-generate
|
||||||
|
steps:
|
||||||
|
- name: Deploy to GitHub Pages
|
||||||
|
id: deployment
|
||||||
|
uses: actions/deploy-pages@v4
|
||||||
|
|
|
||||||
|
|
@ -71,6 +71,8 @@ jobs:
|
||||||
make helm-e2e E2E_TEST_ARGS='-ginkgo.v'
|
make helm-e2e E2E_TEST_ARGS='-ginkgo.v'
|
||||||
|
|
||||||
- name: Test - bats
|
- name: Test - bats
|
||||||
|
env:
|
||||||
|
BATS_LIB_PATH: "${{ github.workspace }}/.bats"
|
||||||
if: ${{ github.event.inputs.skipTests != 'true' }}
|
if: ${{ github.event.inputs.skipTests != 'true' }}
|
||||||
run: make bats-tests
|
run: make bats-tests
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -97,3 +97,7 @@ chart/jenkins-operator/deploy.tmp
|
||||||
|
|
||||||
### Nix
|
### Nix
|
||||||
result
|
result
|
||||||
|
|
||||||
|
### website
|
||||||
|
website/node_modules
|
||||||
|
website/public
|
||||||
|
|
|
||||||
4
Makefile
4
Makefile
|
|
@ -107,7 +107,7 @@ ifeq ($(strip $(HAS_HELM)),)
|
||||||
rm -rf $(PROJECT_DIR)/bin/$(PLATFORM)-amd64
|
rm -rf $(PROJECT_DIR)/bin/$(PLATFORM)-amd64
|
||||||
rm -rf $(PROJECT_DIR)/bin/helm.tar.gz
|
rm -rf $(PROJECT_DIR)/bin/helm.tar.gz
|
||||||
else
|
else
|
||||||
mkdir -p $(PROJECT_DIR)/bin
|
mkdir -p $(PROJECT_DIR)/bin
|
||||||
test -L $(PROJECT_DIR)/bin/helm || ln -sf $(shell command -v helm) $(PROJECT_DIR)/bin/helm
|
test -L $(PROJECT_DIR)/bin/helm || ln -sf $(shell command -v helm) $(PROJECT_DIR)/bin/helm
|
||||||
endif
|
endif
|
||||||
|
|
||||||
|
|
@ -451,7 +451,7 @@ endif
|
||||||
|
|
||||||
# Download and build hugo extended locally if necessary
|
# Download and build hugo extended locally if necessary
|
||||||
HUGO_PATH = $(shell pwd)/bin/hugo
|
HUGO_PATH = $(shell pwd)/bin/hugo
|
||||||
HUGO_VERSION = v0.113.0
|
HUGO_VERSION = v0.99.1
|
||||||
HAS_HUGO := $(shell $(HUGO_PATH)/hugo version 2>&- | grep $(HUGO_VERSION))
|
HAS_HUGO := $(shell $(HUGO_PATH)/hugo version 2>&- | grep $(HUGO_VERSION))
|
||||||
hugo:
|
hugo:
|
||||||
ifeq ($(HAS_HUGO), )
|
ifeq ($(HAS_HUGO), )
|
||||||
|
|
|
||||||
17
flake.lock
17
flake.lock
|
|
@ -73,6 +73,22 @@
|
||||||
"type": "github"
|
"type": "github"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"hugo_099": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1657975505,
|
||||||
|
"narHash": "sha256-juMbw+GY2ycTrg3QbdFfEQs6P3FJeoYEv8aMVl2EZsg=",
|
||||||
|
"owner": "nixos",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "d6df226c53d46821bd4773bd7ec3375f30238edb",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nixos",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "d6df226c53d46821bd4773bd7ec3375f30238edb",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
"nixpkgs": {
|
"nixpkgs": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1707451808,
|
"lastModified": 1707451808,
|
||||||
|
|
@ -95,6 +111,7 @@
|
||||||
"go_15": "go_15",
|
"go_15": "go_15",
|
||||||
"golangci": "golangci",
|
"golangci": "golangci",
|
||||||
"gomod2nix": "gomod2nix",
|
"gomod2nix": "gomod2nix",
|
||||||
|
"hugo_099": "hugo_099",
|
||||||
"nixpkgs": "nixpkgs"
|
"nixpkgs": "nixpkgs"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
|
||||||
45
flake.nix
45
flake.nix
|
|
@ -6,6 +6,7 @@
|
||||||
flake-utils.url = "github:numtide/flake-utils";
|
flake-utils.url = "github:numtide/flake-utils";
|
||||||
go_15.url = "github:nixos/nixpkgs/4eccd6f731627ba5ad9915bcf600c9329a34ca78";
|
go_15.url = "github:nixos/nixpkgs/4eccd6f731627ba5ad9915bcf600c9329a34ca78";
|
||||||
golangci.url = "github:nixos/nixpkgs/e912fb83d2155a393e7146da98cda0e455a80fb6";
|
golangci.url = "github:nixos/nixpkgs/e912fb83d2155a393e7146da98cda0e455a80fb6";
|
||||||
|
hugo_099.url = "github:nixos/nixpkgs/d6df226c53d46821bd4773bd7ec3375f30238edb";
|
||||||
gomod2nix = {
|
gomod2nix = {
|
||||||
url = "github:nix-community/gomod2nix";
|
url = "github:nix-community/gomod2nix";
|
||||||
inputs.nixpkgs.follows = "nixpkgs";
|
inputs.nixpkgs.follows = "nixpkgs";
|
||||||
|
|
@ -13,12 +14,13 @@
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
outputs = { self, nixpkgs, flake-utils, go_15, golangci, gomod2nix, ... }:
|
outputs = { self, nixpkgs, flake-utils, go_15, golangci, gomod2nix, hugo_099, ... }:
|
||||||
flake-utils.lib.eachDefaultSystem (system:
|
flake-utils.lib.eachDefaultSystem (system:
|
||||||
let
|
let
|
||||||
pkgs = nixpkgs.legacyPackages.${system};
|
pkgs = nixpkgs.legacyPackages.${system};
|
||||||
go_15_pkgs = go_15.legacyPackages.${system};
|
go_15_pkgs = go_15.legacyPackages.${system};
|
||||||
golangci_pkgs = golangci.legacyPackages.${system};
|
golangci_pkgs = golangci.legacyPackages.${system};
|
||||||
|
hugo_099_pkgs = hugo_099.legacyPackages.${system};
|
||||||
operatorVersion = builtins.readFile ./VERSION.txt;
|
operatorVersion = builtins.readFile ./VERSION.txt;
|
||||||
sdkVersion = ((builtins.fromTOML (builtins.readFile ./config.base.env)).OPERATOR_SDK_VERSION);
|
sdkVersion = ((builtins.fromTOML (builtins.readFile ./config.base.env)).OPERATOR_SDK_VERSION);
|
||||||
jenkinsLtsVersion = ((builtins.fromTOML (builtins.readFile ./config.base.env)).LATEST_LTS_VERSION);
|
jenkinsLtsVersion = ((builtins.fromTOML (builtins.readFile ./config.base.env)).LATEST_LTS_VERSION);
|
||||||
|
|
@ -30,32 +32,41 @@
|
||||||
# shell in nix develop
|
# shell in nix develop
|
||||||
devShells.default = nixpkgs.legacyPackages.${system}.mkShell {
|
devShells.default = nixpkgs.legacyPackages.${system}.mkShell {
|
||||||
packages = [
|
packages = [
|
||||||
pkgs.gnumake
|
pkgs.gnumake
|
||||||
pkgs.wget
|
pkgs.wget
|
||||||
pkgs.helm-docs
|
pkgs.helm-docs
|
||||||
(pkgs.writeShellApplication {
|
(pkgs.writeShellApplication {
|
||||||
name = "make_matrix";
|
name = "make_matrix";
|
||||||
runtimeInputs = with pkgs; [ bash gnugrep gawk ];
|
runtimeInputs = with pkgs; [ bash gnugrep gawk ];
|
||||||
text = builtins.readFile ./test/make_matrix_ginkgo.sh;
|
text = builtins.readFile ./test/make_matrix_ginkgo.sh;
|
||||||
})
|
})
|
||||||
go_15_pkgs.go
|
go_15_pkgs.go
|
||||||
golangci_pkgs.golangci-lint
|
golangci_pkgs.golangci-lint
|
||||||
];
|
];
|
||||||
shellHook = ''
|
shellHook = ''
|
||||||
echo Operator Version ${operatorVersion}
|
echo Operator Version ${operatorVersion}
|
||||||
echo Latest Jenkins LTS version: ${jenkinsLtsVersion}
|
echo Latest Jenkins LTS version: ${jenkinsLtsVersion}
|
||||||
echo Operator SDK version: ${sdkVersion}
|
echo Operator SDK version: ${sdkVersion}
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
# nix shell .#gomod
|
# nix shell .#gomod
|
||||||
devShells.gomod = pkgs.callPackage ./nix/shell.nix {
|
devShells.gomod = pkgs.callPackage ./nix/gomod-shell.nix {
|
||||||
inherit (gomod2nix.legacyPackages.${system}) mkGoEnv gomod2nix;
|
inherit (gomod2nix.legacyPackages.${system}) mkGoEnv gomod2nix;
|
||||||
|
};
|
||||||
|
|
||||||
|
# nix shell .#website
|
||||||
|
devShells.website = pkgs.callPackage ./nix/website-shell.nix {
|
||||||
|
inherit pkgs system hugo_099_pkgs;
|
||||||
};
|
};
|
||||||
|
|
||||||
# nix build with gomod2nix
|
# nix build with gomod2nix
|
||||||
packages.default = pkgs.callPackage ./nix {
|
packages.default = pkgs.callPackage ./nix {
|
||||||
inherit (gomod2nix.legacyPackages.${system}) buildGoApplication;
|
inherit (gomod2nix.legacyPackages.${system}) buildGoApplication;
|
||||||
|
};
|
||||||
|
|
||||||
|
packages.website = import ./nix/website-build.nix {
|
||||||
|
inherit pkgs system hugo_099_pkgs;
|
||||||
};
|
};
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
{ pkgs, system, hugo_099_pkgs }:
|
||||||
|
|
||||||
|
let
|
||||||
|
buildPackages = [
|
||||||
|
hugo_099_pkgs.hugo #hugo pre-v100
|
||||||
|
pkgs.nodejs_21 #Node 1.21
|
||||||
|
pkgs.nodePackages.autoprefixer
|
||||||
|
pkgs.nodePackages.postcss
|
||||||
|
pkgs.nodePackages.postcss-cli
|
||||||
|
];
|
||||||
|
baseUrl = ((builtins.fromTOML (builtins.readFile ../website/config.toml)).baseURL);
|
||||||
|
in
|
||||||
|
pkgs.buildNpmPackage {
|
||||||
|
name = "jenkins-kubernetes-operator-website";
|
||||||
|
src = ../website;
|
||||||
|
version = "0.0.1";
|
||||||
|
npmDepsHash = "sha256-NcspVYF+9dCrGxH/cGNhD+TxLZm6ZDX523mKm9smAAA=";
|
||||||
|
nativeBuildInputs = buildPackages;
|
||||||
|
buildPhase = "npm run build";
|
||||||
|
installPhase = "cp -r public $out";
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
{ pkgs, system, hugo_099_pkgs }:
|
||||||
|
|
||||||
|
let
|
||||||
|
devShellPackages = [
|
||||||
|
hugo_099_pkgs.hugo #hugo pre-v100
|
||||||
|
pkgs.nodejs_21 #Node 1.21
|
||||||
|
];
|
||||||
|
baseUrl = ((builtins.fromTOML (builtins.readFile ../website/config.toml)).baseURL);
|
||||||
|
in
|
||||||
|
pkgs.mkShell {
|
||||||
|
packages = devShellPackages;
|
||||||
|
shellHook = ''
|
||||||
|
npm install --save-dev
|
||||||
|
npm list
|
||||||
|
'';
|
||||||
|
BASE_URL = "${baseUrl}";
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
has nix && use flake ../.#website
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
# How to Contribute
|
|
||||||
|
|
||||||
We'd love to accept your patches and contributions to this project. There are
|
|
||||||
just a few small guidelines you need to follow.
|
|
||||||
|
|
||||||
## Contributor License Agreement
|
|
||||||
|
|
||||||
Contributions to this project must be accompanied by a Contributor License
|
|
||||||
Agreement. You (or your employer) retain the copyright to your contribution;
|
|
||||||
this simply gives us permission to use and redistribute your contributions as
|
|
||||||
part of the project. Head over to <https://cla.developers.google.com/> to see
|
|
||||||
your current agreements on file or to sign a new one.
|
|
||||||
|
|
||||||
You generally only need to submit a CLA once, so if you've already submitted one
|
|
||||||
(even if it was for a different project), you probably don't need to do it
|
|
||||||
again.
|
|
||||||
|
|
||||||
## Code reviews
|
|
||||||
|
|
||||||
All submissions, including submissions by project members, require review. We
|
|
||||||
use GitHub pull requests for this purpose. Consult
|
|
||||||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
|
||||||
information on using pull requests.
|
|
||||||
|
|
||||||
## Community Guidelines
|
|
||||||
|
|
||||||
This project follows
|
|
||||||
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
|
|
||||||
201
website/LICENSE
201
website/LICENSE
|
|
@ -1,201 +0,0 @@
|
||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: "v0.6.x"
|
title: "v0.6.x"
|
||||||
linkTitle: "v0.6.x"
|
linkTitle: "v0.6.x"
|
||||||
weight: 1
|
weight: 2
|
||||||
date: 2021-12-08
|
date: 2021-12-08
|
||||||
description: >
|
description: >
|
||||||
How to work with Jenkins Operator 0.6.x version. We recommend migrating to a newer version.
|
How to work with Jenkins Operator 0.6.x version. We recommend migrating to a newer version.
|
||||||
|
|
@ -15,5 +15,5 @@ This document describes a getting started guide for **Jenkins Operator** `v0.6.x
|
||||||
|
|
||||||
Prepare your Kubernetes cluster and set up your `kubectl` access.
|
Prepare your Kubernetes cluster and set up your `kubectl` access.
|
||||||
|
|
||||||
Once you have a running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the
|
Once you have a running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the
|
||||||
[Installation](/kubernetes-operator/docs/getting-started/latest/installing-the-operator/) guide.
|
[Installation](/kubernetes-operator/docs/getting-started/latest/installing-the-operator/) guide.
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
---
|
---
|
||||||
title: "Latest (v0.8.x)"
|
title: "v0.7.x"
|
||||||
linkTitle: "Latest (v0.8.x)"
|
linkTitle: "v0.7.x"
|
||||||
weight: 1
|
weight: 1
|
||||||
date: 2021-12-08
|
date: 2021-12-08
|
||||||
description: >
|
description: >
|
||||||
How to work with the latest, currently supported Jenkins Operator version.
|
How to work with Jenkins Operator 0.6.x version. We recommend migrating to a newer version.
|
||||||
---
|
---
|
||||||
|
|
||||||
{{% pageinfo %}}
|
{{% pageinfo %}}
|
||||||
|
|
|
||||||
|
|
@ -7,8 +7,7 @@ description: >
|
||||||
Jenkins security and hardening out of the box
|
Jenkins security and hardening out of the box
|
||||||
---
|
---
|
||||||
|
|
||||||
By default **Jenkins Operator** performs an initial security hardening of Jenkins instance
|
By default **Jenkins Operator** performs an initial security hardening of Jenkins instance via groovy scripts to prevent any security gaps.
|
||||||
via groovy scripts to prevent any security gaps.
|
|
||||||
|
|
||||||
## Jenkins Access Control
|
## Jenkins Access Control
|
||||||
|
|
||||||
|
|
@ -67,4 +66,4 @@ If you find a vulnerability or any misconfiguration in Jenkins, please report it
|
||||||
[jenkins-operator-role]:https://github.com/jenkinsci/kubernetes-operator/blob/v0.6.0/deploy/all-in-one-v1alpha2.yaml
|
[jenkins-operator-role]:https://github.com/jenkinsci/kubernetes-operator/blob/v0.6.0/deploy/all-in-one-v1alpha2.yaml
|
||||||
[jenkins-controller-role]:https://github.com/jenkinsci/kubernetes-operator/blob/v0.6.0/pkg/configuration/base/resources/rbac.go
|
[jenkins-controller-role]:https://github.com/jenkinsci/kubernetes-operator/blob/v0.6.0/pkg/configuration/base/resources/rbac.go
|
||||||
[base-configuration]:https://github.com/jenkinsci/kubernetes-operator/blob/master/pkg/configuration/base/resources/base_configuration_configmap.go
|
[base-configuration]:https://github.com/jenkinsci/kubernetes-operator/blob/master/pkg/configuration/base/resources/base_configuration_configmap.go
|
||||||
[issues]:https://github.com/jenkinsci/kubernetes-operator/issues
|
[issues]:https://github.com/jenkinsci/kubernetes-operator/issues
|
||||||
|
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
#Copyright 2018 Google LLC
|
|
||||||
#
|
|
||||||
#Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
#you may not use this file except in compliance with the License.
|
|
||||||
#You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# https://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
#Unless required by applicable law or agreed to in writing, software
|
|
||||||
#distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
#WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
#See the License for the specific language governing permissions and
|
|
||||||
#limitations under the License.
|
|
||||||
#
|
|
||||||
rm -rf public/
|
|
||||||
HUGO_ENV="production" hugo --gc || exit 1
|
|
||||||
s3deploy -source=public/ -region=eu-west-1 -bucket=bep.is -distribution-id=E8OKNT7W9ZYZ2 -path temp/td
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,23 +1,11 @@
|
||||||
{
|
{
|
||||||
"name": "tech-doc-hugo",
|
"name": "website",
|
||||||
"version": "0.0.1",
|
"scripts": {
|
||||||
"description": "Hugo theme for technical documentation.",
|
"build": "echo $BASE_URL; hugo --minify --baseURL=${BASE_URL}"
|
||||||
"main": "none.js",
|
},
|
||||||
"scripts": {
|
"devDependencies": {
|
||||||
"test": "echo \"Error: no test specified\" && exit 1"
|
|
||||||
},
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "git+https://github.com/bep/tech-doc-hugo.git"
|
|
||||||
},
|
|
||||||
"author": "",
|
|
||||||
"license": "ISC",
|
|
||||||
"bugs": {
|
|
||||||
"url": "https://github.com/bep/tech-doc-hugo/issues"
|
|
||||||
},
|
|
||||||
"homepage": "https://github.com/bep/tech-doc-hugo#readme",
|
|
||||||
"devDependencies": {
|
|
||||||
"autoprefixer": "^10.4.18",
|
"autoprefixer": "^10.4.18",
|
||||||
|
"postcss": "^8.4.35",
|
||||||
"postcss-cli": "^11.0.0"
|
"postcss-cli": "^11.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue