Skip to content

docs: add development and deployment guide to README #166

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

Merged
francescarpi merged 2 commits into from
Apr 22, 2026
+39 −2
Merged

docs: add development and deployment guide to README #166

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9d1cb0
docs: add development and deployment guide to README
francescarpi Apr 19, 2026
39d7ead
docs: add releases and deploys guide
francescarpi Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
name: Deploy to GitHub Pages

on:
push:
branches: [main]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions:
Expand Down
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,22 @@ import Layout from '../../layouts/Layout.astro'
### 5. Sitemap

- The sitemap is automatically generated on every build. No manual action is required.

## Development & Deployment

### Branching Strategy

The main branch is `main`. All development work should be done in feature branches created from `main`. All changes must go through a pull request and require approval from the team before merging.

### Deployment Process

When it's time to deploy a new version, follow these steps:

1. Create a new branch from `main` using the format: `chore/<VERSION>`. For example: `chore/v1.0.0`
2. Update the version in `package.json`
3. Create a commit with the message: `chore: version 1.0.0`
4. Create a pull request. Once merged to `main`, pull the latest code.
5. Create a new tag: `git tag v1.0.0`
6. Push the tag: `git push origin v1.0.0`
7. Go to GitHub, navigate to the Releases section, and create a new release. Select the tag and click "Generate release notes", then publish.
8. Finally, go to GitHub Actions, select "Deploy to GitHub Pages", choose the tag you want to deploy, and run the workflow.
Loading