Skip to content

Commit

Permalink
chore: migrate docs repo into this repo (#2237)
Browse files Browse the repository at this point in the history
  • Loading branch information
jdx authored Jun 1, 2024
1 parent 7552338 commit 7f6c51d
Show file tree
Hide file tree
Showing 84 changed files with 4,692 additions and 59 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: mise-docs

on:
push:
paths:
- "docs/**"
branches:
- main
pull_request:
paths:
- "docs/**"
branches:
- main

concurrency:
group: mise-docs-release-${{ github.head_ref }}
cancel-in-progress: true

env:
MISE_EXPERIMENTAL: 1

jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # for lastUpdated
- uses: jdx/mise-action@v2
with:
install_args: bun
working_directory: docs
- run: bun install
working-directory: docs
- run: bun run docs:build
working-directory: docs
- if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: mise run release-docs
working-directory: docs
env:
AWS_ACCESS_KEY_ID: ${{ secrets.CLOUDFLARE_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.CLOUDFLARE_SECRET_ACCESS_KEY }}
26 changes: 7 additions & 19 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: release
on:
push:
tags: ["v*"]
branches: ["release", "win"]
branches: ["release", "win", "docs"]
workflow_dispatch:

concurrency:
Expand Down Expand Up @@ -250,20 +250,18 @@ jobs:
- build-tarball-win
steps:
- uses: actions/checkout@v4
- uses: crazy-max/ghaction-import-gpg@v6
with:
path: mise
- uses: actions/checkout@v4
with:
repository: jdx/mise-docs
path: mise-docs
token: ${{ secrets.RTX_GITHUB_BOT_TOKEN }}
gpg_private_key: ${{ secrets.MISE_GPG_KEY }}
git_user_signingkey: true
git_commit_gpgsign: true
- name: cache zipsign
id: cache-zipsign
uses: actions/cache@v4
with:
path: ~/.cargo/bin/zipsign
key: cargo-zipsign
- run: ./mise/scripts/setup-zipsign.sh
- run: ./scripts/setup-zipsign.sh
env:
ZIPSIGN: ${{ secrets.ZIPSIGN }}
- name: Install fd-find
Expand All @@ -281,12 +279,6 @@ jobs:
with:
key: ${{ secrets.RTX_SSH_KEY }}
known_hosts: ${{ secrets.RTX_KNOWN_HOSTS_AUR }}
- uses: crazy-max/ghaction-import-gpg@v6
with:
gpg_private_key: ${{ secrets.MISE_GPG_KEY }}
git_user_signingkey: true
git_commit_gpgsign: true
workdir: mise-docs
- uses: actions/download-artifact@v4
with: { path: artifacts }
- run: ls -R artifacts
Expand All @@ -299,16 +291,12 @@ jobs:
mise-v*.zip
merge-multiple: true
- run: ls -R artifacts
- run: mise/scripts/release.sh
- run: scripts/release.sh
env:
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
CLOUDFLARE_ACCESS_KEY_ID: ${{ secrets.CLOUDFLARE_ACCESS_KEY_ID }}
CLOUDFLARE_SECRET_ACCESS_KEY: ${{ secrets.CLOUDFLARE_SECRET_ACCESS_KEY }}
- name: mise-docs push
if: startsWith(github.event.ref, 'refs/tags/v')
run: git push
working-directory: mise-docs
- name: GitHub Release Assets
uses: softprops/action-gh-release@v2
if: startsWith(github.event.ref, 'refs/tags/v')
Expand Down
8 changes: 4 additions & 4 deletions .idea/mise.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"MD004": false,
"MD013": false,
"MD029": false,
"MD033": false,
"MD040": false,
"MD041": false
Expand Down
17 changes: 17 additions & 0 deletions .mise/tasks/release-docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#!/usr/bin/env bash
set -xeuo pipefail

export AWS_REGION=auto
export AWS_ENDPOINT_URL=https://6e243906ff257b965bcae8025c2fc344.r2.cloudflarestorage.com

bun run docs:build

if [ $((RANDOM % 30)) -eq 0 ]; then
# delete old assets only roughly 1/30 times
# deleting old assets can break the site for people currently on it
# but it's also good to keep things tidy
aws s3 rm --recursive s3://mise/assets/
aws s3 rm --recursive --exclude "*" --include "*.html" s3://mise/
fi

aws s3 cp --recursive .vitepress/dist s3://mise/
176 changes: 176 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### macOS Patch ###
# iCloud generated files
*.icloud

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

# VitePress
.vitepress/cache
.vitepress/dist
12 changes: 12 additions & 0 deletions docs/.mise.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
tasks.dev = "bun run docs:dev"
tasks.build = "bun run docs:build"

[tasks."commit-and-push"]
depends = ["build"]
run = [
"git ci -pm docs",
"git push",
]

[tools]
bun = 'latest'
Loading

0 comments on commit 7f6c51d

Please sign in to comment.