Skip to content

Commit

Permalink
Move to new organization.
Browse files Browse the repository at this point in the history
  • Loading branch information
io7m committed Apr 29, 2024
1 parent efc4e86 commit 9e2bacf
Show file tree
Hide file tree
Showing 36 changed files with 166 additions and 25 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/main.linux.temurin.lts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ jobs:
name: test-logs
path: ./com.io7m.zeptoblog.tests/target/surefire-reports
- name: Coverage
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4.3.0
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: com.io7m.zeptoblog.tests/target/site/jacoco-aggregate/jacoco.xml
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
[submodule ".jenkins"]
path = .jenkins
url = http://github.com/io7m/jenkinsfiles
1 change: 0 additions & 1 deletion .jenkins
Submodule .jenkins deleted from 3213e2
3 changes: 2 additions & 1 deletion README-CHANGES.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<c:changelog project="com.io7m.zeptoblog" xmlns:c="urn:com.io7m.changelog:4.0">
<c:releases/>
<c:ticket-systems>
<c:ticket-system default="true" id="com.github.io7m.zeptoblog" url="https://github.com/io7m/zeptoblog/issues/"/>
<c:ticket-system default="true" id="com.github.io7m.zeptoblog"
url="https://github.com/io7m-com/zeptoblog/issues/"/>
</c:ticket-systems>
</c:changelog>
69 changes: 69 additions & 0 deletions README.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@

## Usage

Create a configuration file (in [Java properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html) format):

```
# The blog title
com.io7m.zeptoblog.title = Example Blog

# The blog source tree
com.io7m.zeptoblog.source_root = /home/someone/blog-src

# The output directory tree
com.io7m.zeptoblog.output_root = /tmp/blog-out

# The number of posts per page
com.io7m.zeptoblog.posts_per_page = 30

# The site URI
com.io7m.zeptoblog.site_uri = http://blog.io7m.com/

# The author information that will appear in Atom feeds
com.io7m.zeptoblog.author = [email protected]

# The default format of blog posts (CommonMark, here)
com.io7m.zeptoblog.format_default = com.io7m.zeptoblog.commonmark
```

Create posts by creating files in `com.io7m.zeptoblog.source_root` with names ending in `.zbp`.

Posts must consist of a series of commands that specify the date
(in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) and
title of the post, followed by an empty line, followed by the body
of the post in [CommonMark](http://commonmark.org/) format.

```
$ cat /home/someone/blog-src/2017/02/24/post.zbp
title An example post
date 2017-02-24T19:37:48+0000

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur
efficitur sed nisi ac volutpat.

![Ladybug](/2017/02/24/ladybug.jpg)
```

Files can appear anywhere in `com.io7m.zeptoblog.source_root`,
including any subdirectory, and directory names do not carry any
specific meaning. Organizing posts by `year/month/day` is merely a
useful convention. Any files with names not ending in `.zbp` will
be copied unmodified to the output directory.

Compile the blog:

```
$ java -jar com.io7m.zeptoblog.cmdline-0.2.0-main.jar compile -config blog.conf
```

Sign pages with `gpg`:

```
$ find /tmp/blog-out -name '*.xhtml' -type f -exec gpg -a --detach-sign -u 'my key id' {} \;
```

Use [rsync](https://rsync.samba.org/) to copy `/tmp/blog-out` to a site.

## Real-world Examples

https://blog.io7m.com
80 changes: 75 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,83 @@ zeptoblog

[![Maven Central](https://img.shields.io/maven-central/v/com.io7m.zeptoblog/com.io7m.zeptoblog.svg?style=flat-square)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.io7m.zeptoblog%22)
[![Maven Central (snapshot)](https://img.shields.io/nexus/s/com.io7m.zeptoblog/com.io7m.zeptoblog?server=https%3A%2F%2Fs01.oss.sonatype.org&style=flat-square)](https://s01.oss.sonatype.org/content/repositories/snapshots/com/io7m/zeptoblog/)
[![Codecov](https://img.shields.io/codecov/c/github/io7m/zeptoblog.svg?style=flat-square)](https://codecov.io/gh/io7m/zeptoblog)
[![Codecov](https://img.shields.io/codecov/c/github/io7m-com/zeptoblog.svg?style=flat-square)](https://codecov.io/gh/io7m-com/zeptoblog)

![com.io7m.zeptoblog](./src/site/resources/zeptoblog.jpg?raw=true)

| JVM | Platform | Status |
|-----|----------|--------|
| OpenJDK (Temurin) Current | Linux | [![Build (OpenJDK (Temurin) Current, Linux)](https://img.shields.io/github/actions/workflow/status/io7m/zeptoblog/main.linux.temurin.current.yml)](https://github.com/io7m/zeptoblog/actions?query=workflow%3Amain.linux.temurin.current)|
| OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m/zeptoblog/main.linux.temurin.lts.yml)](https://github.com/io7m/zeptoblog/actions?query=workflow%3Amain.linux.temurin.lts)|
| OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m/zeptoblog/main.windows.temurin.current.yml)](https://github.com/io7m/zeptoblog/actions?query=workflow%3Amain.windows.temurin.current)|
| OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m/zeptoblog/main.windows.temurin.lts.yml)](https://github.com/io7m/zeptoblog/actions?query=workflow%3Amain.windows.temurin.lts)|
| OpenJDK (Temurin) Current | Linux | [![Build (OpenJDK (Temurin) Current, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/zeptoblog/main.linux.temurin.current.yml)](https://github.com/io7m-com/zeptoblog/actions?query=workflow%3Amain.linux.temurin.current)|
| OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/zeptoblog/main.linux.temurin.lts.yml)](https://github.com/io7m-com/zeptoblog/actions?query=workflow%3Amain.linux.temurin.lts)|
| OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/zeptoblog/main.windows.temurin.current.yml)](https://github.com/io7m-com/zeptoblog/actions?query=workflow%3Amain.windows.temurin.current)|
| OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/zeptoblog/main.windows.temurin.lts.yml)](https://github.com/io7m-com/zeptoblog/actions?query=workflow%3Amain.windows.temurin.lts)|

## Usage

Create a configuration file (in [Java properties](https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html) format):

```
# The blog title
com.io7m.zeptoblog.title = Example Blog
# The blog source tree
com.io7m.zeptoblog.source_root = /home/someone/blog-src
# The output directory tree
com.io7m.zeptoblog.output_root = /tmp/blog-out
# The number of posts per page
com.io7m.zeptoblog.posts_per_page = 30
# The site URI
com.io7m.zeptoblog.site_uri = http://blog.io7m.com/
# The author information that will appear in Atom feeds
com.io7m.zeptoblog.author = [email protected]
# The default format of blog posts (CommonMark, here)
com.io7m.zeptoblog.format_default = com.io7m.zeptoblog.commonmark
```

Create posts by creating files in `com.io7m.zeptoblog.source_root` with names ending in `.zbp`.

Posts must consist of a series of commands that specify the date
(in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) and
title of the post, followed by an empty line, followed by the body
of the post in [CommonMark](http://commonmark.org/) format.

```
$ cat /home/someone/blog-src/2017/02/24/post.zbp
title An example post
date 2017-02-24T19:37:48+0000
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur
efficitur sed nisi ac volutpat.
![Ladybug](/2017/02/24/ladybug.jpg)
```

Files can appear anywhere in `com.io7m.zeptoblog.source_root`,
including any subdirectory, and directory names do not carry any
specific meaning. Organizing posts by `year/month/day` is merely a
useful convention. Any files with names not ending in `.zbp` will
be copied unmodified to the output directory.

Compile the blog:

```
$ java -jar com.io7m.zeptoblog.cmdline-0.2.0-main.jar compile -config blog.conf
```

Sign pages with `gpg`:

```
$ find /tmp/blog-out -name '*.xhtml' -type f -exec gpg -a --detach-sign -u 'my key id' {} \;
```

Use [rsync](https://rsync.samba.org/) to copy `/tmp/blog-out` to a site.

## Real-world Examples

https://blog.io7m.com

Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ private static Element metaGenerator(final Document document)
e.setAttribute("name", "generator");
e.setAttribute(
"content",
"https://github.com/io7m/zeptoblog; version=" + version());
"https://github.com/io7m-com/zeptoblog; version=" + version());
return e;
}

Expand Down
1 change: 1 addition & 0 deletions com.io7m.zeptoblog.tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
<properties>
<!-- Disable dependency analysis due to ServiceLoader -->
<mdep.analyze.skip>true</mdep.analyze.skip>
<checkstyle.skip>true</checkstyle.skip>
</properties>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Been experimenting with independent
[module](/glossary.xhtml#module) versioning by developing an
[OSGi IRC bot](https://github.com/io7m/thoth/). The idea is to
[OSGi IRC bot](https://github.com/io7m-com/thoth/). The idea is to
expose any deficiencies in tools when modules within a single
[Maven](/glossary.xhtml#maven) project have different version numbers.

Expand All @@ -17,5 +17,5 @@ has a plugin for this.
Conceptually, moving to independently versioned modules means that a
given _project version_ now describes _a set of module versions_ as
opposed to simply defining a single version for all modules. I might
rewrite [changelog](https://github.com/io7m/changelog) to better fit
rewrite [changelog](https://github.com/io7m-com/changelog) to better fit
with this fundamental conceptual change.
15 changes: 9 additions & 6 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,12 @@
</modules>

<properties>
<!-- Configuration -->
<io7m.api.previousVersion>0.4.0</io7m.api.previousVersion>
<io7m.org.immutables.version>2.10.1</io7m.org.immutables.version>
<io7m.java.targetJavaVersion>21</io7m.java.targetJavaVersion>

<!-- Third-party dependencies. -->
<io7m.org.immutables.version>2.10.1</io7m.org.immutables.version>
<commonmark.version>0.22.0</commonmark.version>
<junit.version>5.10.2</junit.version>
</properties>
Expand All @@ -45,9 +48,9 @@
</licenses>

<scm>
<url>https://github.com/io7m/zeptoblog</url>
<connection>scm:git:https://github.com/io7m/zeptoblog</connection>
<developerConnection>scm:git:https://github.com/io7m/zeptoblog</developerConnection>
<url>https://github.com/io7m-com/zeptoblog</url>
<connection>scm:git:https://github.com/io7m-com/zeptoblog</connection>
<developerConnection>scm:git:https://github.com/io7m-com/zeptoblog</developerConnection>
</scm>

<developers>
Expand All @@ -60,7 +63,7 @@
</developers>

<issueManagement>
<url>https://github.com/io7m/zeptoblog/issues</url>
<url>https://github.com/io7m-com/zeptoblog/issues</url>
<system>GitHub Issues</system>
</issueManagement>

Expand All @@ -82,7 +85,7 @@

<ciManagement>
<system>GitHub Actions</system>
<url>https://github.com/io7m/zeptoblog/actions</url>
<url>https://github.com/io7m-com/zeptoblog/actions</url>
</ciManagement>

<prerequisites>
Expand Down
2 changes: 1 addition & 1 deletion src/site/resources/documentation.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

<div xmlns="http://www.w3.org/1999/xhtml">
<h3>User documentation</h3>
<p>See the <a href="https://github.com/io7m/zeptoblog">README</a>.</p>
<p>See the <a href="https://github.com/io7m-com/zeptoblog">README</a>.</p>
</div>
8 changes: 4 additions & 4 deletions src/site/resources/overview.xml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<div xmlns="http://www.w3.org/1999/xhtml">
<p class="shields">
<a href="https://github.com/io7m/zeptoblog/actions?query=workflow%3Amain.linux.temurin.lts">
<img src="https://img.shields.io/github/actions/workflow/status/io7m/zeptoblog/main.linux.temurin.lts.yml"
<a href="https://github.com/io7m-com/zeptoblog/actions?query=workflow%3Amain.linux.temurin.lts">
<img src="https://img.shields.io/github/actions/workflow/status/io7m-com/zeptoblog/main.linux.temurin.lts.yml"
alt="Build status"/>
</a>
<a href="http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.io7m.zeptoblog%22">
<img src="https://img.shields.io/maven-central/v/com.io7m.zeptoblog/com.io7m.zeptoblog.svg?style=flat-square"
alt="Maven Central"/>
</a>
<a href="https://codecov.io/gh/io7m/zeptoblog">
<img src="https://img.shields.io/codecov/c/github/io7m/zeptoblog.svg?style=flat-square"
<a href="https://codecov.io/gh/io7m-com/zeptoblog">
<img src="https://img.shields.io/codecov/c/github/io7m-com/zeptoblog.svg?style=flat-square"
alt="Codecov"/>
</a>
</p>
Expand Down

0 comments on commit 9e2bacf

Please sign in to comment.