|
1 | | -# otype.de |
| 1 | +<p align="center"> |
| 2 | + <img src="/images/otype_site.png" alt="otype Site"/> |
| 3 | +</p> |
| 4 | + |
| 5 | +<p> |
| 6 | + <a href="https://github.com/otype/otype.github.io/commits/master"> |
| 7 | + <img src="https://img.shields.io/github/last-commit/otype/otype.github.io.svg?style=flat-square&logo=github&logoColor=white" alt="GitHub last commit"> |
| 8 | + <a href="https://github.com/otype/otype.github.io/issues"> |
| 9 | + <img src="https://img.shields.io/github/issues-raw/otype/otype.github.io.svg?style=flat-square&logo=github&logoColor=white" alt="GitHub issues"> |
| 10 | + <a href="https://github.com/otype/otype.github.io/pulls"> |
| 11 | + <img src="https://img.shields.io/github/issues-pr-raw/otype/otype.github.io.svg?style=flat-square&logo=github&logoColor=white" alt="GitHub pull requests"> |
| 12 | +</p> |
| 13 | + |
| 14 | +This repository contains all files for my sites (identical copies): |
| 15 | + |
| 16 | +- [otype.github.io](https://otype.github.io) |
| 17 | +- [otype.de](https://otype.de) |
2 | 18 |
|
3 | | -This repository contains all files for my site [otype.github.io](https://otype.github.io) and [otype.de](https://otype.de). The site is based on [Hugo](https://gohugo.io/). |
| 19 | +The site is based on [Hugo](https://gohugo.io/) and the [hugo-goa](https://github.com/kaapiandcode/hugo-goa) theme. |
4 | 20 |
|
5 | | -## Running locally |
| 21 | +## Getting started |
6 | 22 |
|
7 | | -1. Clone this repo (assumes you are using [gh](https://cli.github.com/)): |
8 | | -``` |
9 | | -gh repo clone otype/otype.de |
10 | | -``` |
| 23 | +### Requirements |
11 | 24 |
|
12 | | -2. Run setup: |
| 25 | +- [Golang](https://go.dev/), installed e.g. via [goenv](https://github.com/syndbg/goenv) |
| 26 | +- [Hugo](https://gohugo.io/) |
| 27 | +- [gh](https://cli.github.com/) |
13 | 28 |
|
| 29 | +### Development setup |
| 30 | + |
| 31 | +1. Clone this repo. |
| 32 | +```console |
| 33 | +$ gh repo clone otype/otype.github.io |
14 | 34 | ``` |
15 | | -make setup |
| 35 | + |
| 36 | +2. Run setup. |
| 37 | + |
| 38 | +```console |
| 39 | +$ make setup |
16 | 40 | ```` |
17 | 41 |
|
18 | | -3. Run server: |
| 42 | +3. Run server. |
19 | 43 |
|
| 44 | +```console |
| 45 | +$ make run |
20 | 46 | ``` |
21 | | -make run |
22 | | -``` |
23 | | -
|
24 | | -## Release and deploy |
25 | 47 |
|
26 | | -This will deploy to: |
27 | | -- [otype.github.io](https://otype.github.io) and |
28 | | -- [otype.de](https://otype.de) |
| 48 | +### Release and deploy a new version |
29 | 49 |
|
30 | | -Assumption: |
31 | | -You have made all changes and pushed to `main`. |
| 50 | +1. Commit and push all changes to `main`. |
32 | 51 |
|
33 | | -Build the site: |
| 52 | +2. Build the site. Default `Makefile` target will run `hugo`. |
34 | 53 |
|
35 | | -``` |
36 | | -make |
| 54 | +```console |
| 55 | +$ make |
37 | 56 | ``` |
38 | 57 |
|
39 | | -Now, create a release (pick a new tag version): |
| 58 | +3. Create a release. Pick a new `tag` version. If unclear check the existing [tags](https://github.com/otype/otype.github.io/tags) in this repository. |
40 | 59 |
|
41 | | -E.g. |
42 | | -``` |
43 | | -gh release create v1.2 --generate-notes |
| 60 | +```console |
| 61 | +$ gh release create v1.2 --generate-notes |
44 | 62 | ``` |
45 | 63 |
|
46 | | -Then, deploy: |
| 64 | +4. Deploy. This automatically updates [otype.github.io](https://otype.github.io) and copies all files to [otype.de](https://otype.de). |
47 | 65 |
|
48 | | -``` |
49 | | -make deploy |
| 66 | +```console |
| 67 | +$ make deploy |
50 | 68 | ``` |
51 | 69 |
|
52 | | -Deploy will implicitly ... |
53 | | -- checkout branch `public`, |
54 | | -- rebase `main`, |
55 | | -- push to `public` |
56 | | -- and `scp` all files to Uberspace. |
| 70 | +The Makefile `deploy` target will implicitly checkout branch `public`, rebase `main`, push to `public` and `scp` all files to Uberspace. |
0 commit comments