Skip to content

Commit ced01f2

Browse files
authored
chore(docs): migrate to bashunit.com (#715)
1 parent ffa9c79 commit ced01f2

18 files changed

Lines changed: 107 additions & 207 deletions

.claude/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**bashunit** is a lightweight Bash testing framework (Bash 3.0+) focused on developer experience. Provides assertions, test doubles (spies/mocks), data providers, snapshots, and more.
66

7-
**Documentation:** https://bashunit.typeddevs.com
7+
**Documentation:** https://bashunit.com
88

99
## Core Principles
1010

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ function my_function() {
328328
329329
- **New contributors:** [Good first issues](https://github.com/TypedDevs/bashunit/labels/good%20first%20issue)
330330
- **Questions:** [GitHub Discussions](https://github.com/TypedDevs/bashunit/discussions)
331-
- **Documentation:** [bashunit.typeddevs.com](https://bashunit.typeddevs.com/)
331+
- **Documentation:** [bashunit.com](https://bashunit.com/)
332332
- **Bug reports:** [Create an issue](https://github.com/TypedDevs/bashunit/issues/new/choose)
333333
- **Feature requests:** [Create an issue](https://github.com/TypedDevs/bashunit/issues/new/choose)
334334
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Deploy Docs (GitHub Pages)
2+
3+
# Publishes the VitePress docs site to GitHub Pages on the bashunit.com custom
4+
# domain. The site is fully static; the installer is copied into the site root
5+
# so `curl -s https://bashunit.com/install.sh | bash` works.
6+
#
7+
# Manual one-time setup:
8+
# - Repo Settings -> Pages -> Source: "GitHub Actions"
9+
# - Repo Settings -> Pages -> Custom domain: bashunit.com (CNAME file is also
10+
# committed at docs/public/CNAME so it ships in the build)
11+
# - At IONOS, point bashunit.com at GitHub Pages:
12+
# apex: A/AAAA records to GitHub Pages IPs
13+
# (or CNAME <owner>.github.io for a www host)
14+
15+
on:
16+
push:
17+
branches:
18+
- latest
19+
workflow_dispatch:
20+
21+
permissions:
22+
contents: read
23+
pages: write
24+
id-token: write
25+
26+
concurrency:
27+
group: github-pages
28+
cancel-in-progress: false
29+
30+
jobs:
31+
build:
32+
runs-on: ubuntu-latest
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v4
36+
with:
37+
fetch-depth: 0
38+
39+
- name: Setup Node
40+
uses: actions/setup-node@v4
41+
with:
42+
node-version: 20
43+
cache: npm
44+
cache-dependency-path: docs/package-lock.json
45+
46+
- name: Install dependencies
47+
working-directory: docs
48+
run: npm ci
49+
50+
- name: Build with VitePress
51+
working-directory: docs
52+
run: npm run build
53+
54+
- name: Copy installer into site root
55+
run: cp install.sh docs/.vitepress/dist/install.sh
56+
57+
- name: Configure Pages
58+
uses: actions/configure-pages@v5
59+
60+
- name: Upload artifact
61+
uses: actions/upload-pages-artifact@v3
62+
with:
63+
path: docs/.vitepress/dist
64+
65+
deploy:
66+
needs: build
67+
runs-on: ubuntu-latest
68+
environment:
69+
name: github-pages
70+
url: ${{ steps.deployment.outputs.page_url }}
71+
steps:
72+
- name: Deploy to GitHub Pages
73+
id: deployment
74+
uses: actions/deploy-pages@v4

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
## Unreleased
44

5+
### Changed
6+
- Documentation and project URLs now point to the new primary domain `bashunit.com` (old `bashunit.typeddevs.com` continues to work as a redirect)
7+
- The docs site now deploys to GitHub Pages on the `bashunit.com` custom domain (`deploy-gh-pages.yml`); the installer is copied into the site root from the repo's canonical `install.sh`
8+
9+
### Removed
10+
- The weekly-downloads chart on the docs homepage (its data source was not portable); to be revisited later
11+
512
## [0.39.1](https://github.com/TypedDevs/bashunit/compare/0.39.0...0.39.1) - 2026-06-09
613

714
### Fixed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ It boasts hundreds of assertions and functionalities like spies, mocks, provider
3939

4040
## Documentation
4141

42-
You can find the complete documentation for **bashunit** online, including installation instructions and the various features it provides, in the [official bashunit documentation](https://bashunit.typeddevs.com).
42+
You can find the complete documentation for **bashunit** online, including installation instructions and the various features it provides, in the [official bashunit documentation](https://bashunit.com).
4343

4444
## Requirements
4545

docs/.vitepress/config.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ export default defineConfig({
1515
['meta', { name: 'theme-color', content: '#22c55e' }],
1616
['meta', { property: 'og:type', content: 'website' }],
1717
['meta', { property: 'og:site_name', content: 'bashunit' }],
18-
['meta', { property: 'og:image', content: 'https://bashunit.typeddevs.com/og-image.png' }],
18+
['meta', { property: 'og:image', content: 'https://bashunit.com/og-image.png' }],
1919
['meta', { name: 'twitter:card', content: 'summary_large_image' }],
2020
['meta', { name: 'twitter:site', content: '@bashunit' }],
21-
['meta', { name: 'twitter:image', content: 'https://bashunit.typeddevs.com/og-image.png' }]
21+
['meta', { name: 'twitter:image', content: 'https://bashunit.com/og-image.png' }]
2222
],
2323
transformHead(context) {
2424
const canonical = context.page.replace(/(index)?\.md$/, '')
25-
const url = `https://bashunit.typeddevs.com/${canonical}`
25+
const url = `https://bashunit.com/${canonical}`
2626
const description = context.description || context.frontmatter?.description ||
2727
'Test your bash scripts in the fastest and simplest way, discover the most modern bash testing library.'
2828

@@ -37,7 +37,7 @@ export default defineConfig({
3737
},
3838

3939
sitemap: {
40-
hostname: 'https://bashunit.typeddevs.com'
40+
hostname: 'https://bashunit.com'
4141
},
4242

4343
themeConfig: {

docs/components/WeeklyDownloads.vue

Lines changed: 0 additions & 179 deletions
This file was deleted.

docs/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,9 @@ features:
3939
details: Seamlessly operates on Linux, macOS, and Windows (via WSL), facilitating a consistent testing environment across major platforms.
4040
---
4141

42-
<WeeklyDownloads />
43-
4442
<script setup lang="ts">
4543
import { onMounted } from 'vue';
4644
import VanillaTilt from 'vanilla-tilt';
47-
import WeeklyDownloads from './components/WeeklyDownloads.vue';
4845

4946
onMounted(() => {
5047
const heroImage = document.querySelector('.VPHero .VPImage');

docs/installation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ There is a tool that will generate an executable with the whole library in a sin
1212

1313
::: code-group
1414
```bash [Linux/Mac]
15-
curl -s https://bashunit.typeddevs.com/install.sh | bash
15+
curl -s https://bashunit.com/install.sh | bash
1616
```
1717

1818
```bash [Windows]
@@ -24,7 +24,7 @@ curl -s https://bashunit.typeddevs.com/install.sh | bash
2424
# - Restart your computer
2525
#
2626
# Step 2: Open your WSL terminal and run:
27-
curl -s https://bashunit.typeddevs.com/install.sh | bash
27+
curl -s https://bashunit.com/install.sh | bash
2828
```
2929
:::
3030

@@ -57,7 +57,7 @@ The installation script can receive arguments (in any order):
5757

5858
::: code-group
5959
```bash [Linux/Mac]
60-
curl -s https://bashunit.typeddevs.com/install.sh | bash -s [dir] [version]
60+
curl -s https://bashunit.com/install.sh | bash -s [dir] [version]
6161
```
6262

6363
```bash [Windows]
@@ -69,7 +69,7 @@ curl -s https://bashunit.typeddevs.com/install.sh | bash -s [dir] [version]
6969
# - Restart your computer
7070
#
7171
# Step 2: Open your WSL terminal and run:
72-
curl -s https://bashunit.typeddevs.com/install.sh | bash -s [dir] [version]
72+
curl -s https://bashunit.com/install.sh | bash -s [dir] [version]
7373
```
7474
:::
7575

@@ -281,7 +281,7 @@ jobs:
281281
runs-on: ubuntu-latest
282282
steps:
283283
- uses: actions/checkout@v4
284-
- run: curl -s https://bashunit.typeddevs.com/install.sh | bash
284+
- run: curl -s https://bashunit.com/install.sh | bash
285285
- run: ./lib/bashunit tests
286286
```
287287

docs/public/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
bashunit.com

0 commit comments

Comments
 (0)