Skip to content

docs: adding the workflow yaml and the default from docs-template #2064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

docs: adding the workflow yaml and the default from docs-template #2064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22aa073
adding the workflow yaml and the default from docs-template.
LAShemilt Oct 15, 2025
42d45ab
update branch from main to master
LAShemilt Oct 20, 2025
4b439b8
Use action tag
minottic Oct 23, 2025
0addff6
Merge branch 'master' into docs-ci
minottic Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/mkdocs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
INHERIT: mkdocs-default.yml
# nav:
# - index.md
# - Example.md
# - About: about/index.md
17 changes: 17 additions & 0 deletions .github/workflows/publish-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Deploy docs

on: # yamllint disable-line rule:truthy
push:
branches:
- master
tags:
- v*

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: SciCatProject/docs-template/.github/actions/mkdocs-pages@v0.0.1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha): An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

Source: opengrep

with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
push: true
Loading