Skip to content
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

Jump to bottom

dev: use to GitHub Pages #3884

Merged
merged 2 commits into from Jun 5, 2023
Merged

dev: use to GitHub Pages #3884

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de3c5aa
chore: migrate to GitHub Pages
ldez Jun 3, 2023
60b7144
chore: use another GHA to deploy GH pages
ldez Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/workflows/documentation.yml
View file
Open in desktop
@@ -0,0 +1,65 @@
name: Documentation

on:
push:
branches:
- master
Comment on lines +3 to +6
Copy link
Member

Choose a reason for hiding this comment

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

If this will be an alternative official documentation, should this rather be when tagging and not pushing to master?

Copy link
Member Author

@ldez ldez Jun 5, 2023 •
edited

Choose a reason for hiding this comment

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

currently, we publish the doc every time a change happens on the doc.
It's a requirement to be able to apply a fix on the documentation.

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense! Would be nice if we could clarify that. It will f.ex. also add docs for new linters not yet released.

Copy link
Member Author

@ldez ldez Jun 5, 2023 •
edited

Choose a reason for hiding this comment

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

It's already the case, I added Since in the documentation there is a long time ago (2021) in #1854.

https://golangci-lint.run/usage/linters/

Copy link
Member

Choose a reason for hiding this comment

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

Yeah I know but that requires people to actually read the docs and figure out what the current version is :)

It was also just an example but let’s see if it becomes a problem and not try to solve anything until then!


jobs:

doc:
name: Build and deploy documentation
runs-on: ubuntu-latest
env:
GO_VERSION: '1.20'
NODE_VERSION: '20.x'
CGO_ENABLED: 0

steps:
- name: Check out code
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set up Go ${{ env.GO_VERSION }}
uses: actions/setup-go@v3
with:
go-version: ${{ env.GO_VERSION }}

- name: Cache Go modules
uses: actions/cache@v3
with:
# In order:
# * Module download cache
# * Build cache (Linux)
path: |
~/go/pkg/mod
~/.cache/go-build
key: docs-${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
docs-${{ runner.os }}-go-

- run: go mod download

- name: Use Node.js ${{ env.NODE_VERSION }}
uses: actions/setup-node@v3
with:
node-version: ${{ env.NODE_VERSION }}
cache: npm
cache-dependency-path: docs/package-lock.json

- run: npm install --legacy-peer-deps
working-directory: ./docs

- name: Build Documentation
run: npm run build
working-directory: ./docs

- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v3
ldez marked this conversation as resolved.
Show resolved Hide resolved
with:
target_branch: gh-pages
build_dir: docs/public
env:
GITHUB_TOKEN: ${{ secrets.GOLANGCI_LINT_TOKEN }}