mirror of
				https://github.com/XRPLF/clio.git
				synced 2025-11-04 03:45:50 +00:00 
			
		
		
		
	I started with really simple pre-commit hooks and will add more on top. Important files: - `.pre-commit-config.yaml` - the config for pre-commit - `.github/workflows/pre-commit.yml` - runs pre-commit hooks in branches and `develop` - `.github/workflows/pre-commit-autoupdate.yml` - autoupdates pre-commit hooks once in a month
		
			
				
	
	
		
			50 lines
		
	
	
		
			1.0 KiB
		
	
	
	
		
			YAML
		
	
	
	
	
	
			
		
		
	
	
			50 lines
		
	
	
		
			1.0 KiB
		
	
	
	
		
			YAML
		
	
	
	
	
	
name: Documentation
 | 
						|
on:
 | 
						|
  push:
 | 
						|
    branches: [develop]
 | 
						|
  workflow_dispatch:
 | 
						|
 | 
						|
permissions:
 | 
						|
  contents: read
 | 
						|
  pages: write
 | 
						|
  id-token: write
 | 
						|
 | 
						|
concurrency:
 | 
						|
  group: "pages"
 | 
						|
  cancel-in-progress: true
 | 
						|
 | 
						|
jobs:
 | 
						|
  deploy:
 | 
						|
    environment:
 | 
						|
      name: github-pages
 | 
						|
      url: ${{ steps.deployment.outputs.page_url }}
 | 
						|
    runs-on: ubuntu-latest
 | 
						|
    continue-on-error: true
 | 
						|
    container:
 | 
						|
      image: rippleci/clio_ci:latest
 | 
						|
    steps:
 | 
						|
      - name: Checkout
 | 
						|
        uses: actions/checkout@v4
 | 
						|
        with:
 | 
						|
          lfs: true
 | 
						|
 | 
						|
      - name: Build docs
 | 
						|
        run: |
 | 
						|
          mkdir -p build_docs && cd build_docs
 | 
						|
          cmake ../docs && cmake --build . --target docs
 | 
						|
 | 
						|
      - name: Setup Pages
 | 
						|
        uses: actions/configure-pages@v5
 | 
						|
 | 
						|
      - name: Upload artifact
 | 
						|
        uses: actions/upload-pages-artifact@v3
 | 
						|
        with:
 | 
						|
          path: build_docs/html
 | 
						|
          name: docs-develop
 | 
						|
 | 
						|
      - name: Deploy to GitHub Pages
 | 
						|
        id: deployment
 | 
						|
        uses: actions/deploy-pages@v4
 | 
						|
        with:
 | 
						|
          artifact_name: docs-develop
 |