Skip to content

Commit c91f4af

Browse files
authored
docs: add development and deployment guide to README (#166)
1 parent a3e508c commit c91f4af

3 files changed

Lines changed: 39 additions & 2 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
name: Deploy to GitHub Pages
22

33
on:
4-
push:
5-
branches: [main]
4+
# Allows you to run this workflow manually from the Actions tab
65
workflow_dispatch:
76

87
permissions:

.github/workflows/release.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Automatic release when package.json version changes
2+
name: Release
3+
4+
on:
5+
push:
6+
branches: [main]
7+
paths: [package.json]
8+
9+
jobs:
10+
release:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
- uses: justincy/github-action-npm-release@2.0.2

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,24 @@ import Layout from '../../layouts/Layout.astro'
7676
### 5. Sitemap
7777

7878
- The sitemap is automatically generated on every build. No manual action is required.
79+
80+
## Releases & Deploys
81+
82+
### Creating a Release
83+
84+
The release workflow automatically detects version changes in `package.json`. When you push to `main` with an updated version, it automatically:
85+
86+
1. Creates a git tag
87+
2. Generates a changelog from commit history
88+
3. Creates a GitHub Release
89+
90+
### Deploying
91+
92+
Deployment is manual and triggered from GitHub Actions:
93+
94+
1. Go to **Actions → Deploy to GitHub Pages**
95+
2. Select the tag you want to deploy (e.g., `v1.0.0`)
96+
3. Click **Run workflow**
97+
98+
The site is deployed to GitHub Pages at `https://2026.es.pycon.org/`.
99+

0 commit comments

Comments
 (0)