prepare release v1.6.0 (#122)
All checks were successful
ci/woodpecker/push/docs Pipeline was successful
ci/woodpecker/push/ci Pipeline was successful
ci/woodpecker/tag/docs Pipeline was successful
ci/woodpecker/tag/ci Pipeline was successful

### 📖 Summary

- updatee changelog
- add blog post
- update guides

### 📑 Test Plan

 CI pipeline tests (Default)

### 💬 Details

_No response_

### 📚 Additional Notes

_No response_

Reviewed-on: #122
This commit is contained in:
OCram85 2024-08-01 10:46:28 +02:00
parent 4f85a8a855
commit ea513c90ac
14 changed files with 187 additions and 13 deletions

View File

@ -33,8 +33,7 @@ steps:
platforms: linux/amd64
auto_tag: true
build_args:
- VERSION=${CI_COMMIT_TAG:-PR ${CI_COMMIT_PULL_REQUEST}}
- TAG=${CI_COMMIT_TAG}
- CI=${CI}
when:
event: pull_request
branch: ${CI_REPO_DEFAULT_BRANCH}
@ -47,9 +46,9 @@ steps:
platforms: linux/amd64
auto_tag: true
logins: *publish_logins
build_args:
- VERSION=${CI_COMMIT_TAG:-PR ${CI_COMMIT_PULL_REQUEST}}
- TAG=${CI_COMMIT_TAG}
#build_args:
# - VERSION=${CI_COMMIT_TAG:-PR ${CI_COMMIT_PULL_REQUEST}}
# - TAG=${CI_COMMIT_TAG}
when:
event: [push, tag, cron]
branch: ${CI_REPO_DEFAULT_BRANCH}
@ -63,7 +62,7 @@ steps:
tag: next
logins: *publish_logins
build_args:
- VERSION=${CI_COMMIT_TAG:-PR ${CI_COMMIT_PULL_REQUEST}}
- TAG=${CI_COMMIT_TAG}
- CI=${CI}
- CI_COMMIT_PULL_REQUEST=${CI_COMMIT_PULL_REQUEST}
when:
event: [pull_request]

View File

@ -1,3 +1,19 @@
## [v1.6.0](https://gitea.ocram85.com/arkanum/arkanum/releases/tag/v1.6.0) - 2024-07-31
* ✨ FEATURES
* Add arkanum branding for code-server (#120)
* Add lazygit (#116)
* 🛠️ ENHANCEMENTS
* Update brand assets (#121)
* Migrate codeberg organization to arkanum (#117)
* 🤖 DEPENDENCIES
* Chore(deps): update woodpeckerci/plugin-docker-buildx docker tag to v4.2.0 (#119)
* Chore(deps): update quay.io/linuxserver.io/code-server docker tag to v4.91.1 (#118)
* Chore(deps): update dependency rimraf to v6 (#115)
* Chore(deps): update woodpeckerci/plugin-docker-buildx docker tag to v4.1.0 (#114)
* Add renovate reviewer (#113)
* Chore(deps): update quay.io/linuxserver.io/code-server docker tag to v4.91.0 (#112)
## [v1.5.3](https://gitea.ocram85.com/arkanum/arkanum/releases/tag/v1.5.3) - 2024-06-20
* 🛠️ ENHANCEMENTS

View File

@ -57,7 +57,7 @@ ADD FiraCode/fonts.css ./
RUN cat fonts.css >> workbench.web.main.css
#endregion firacode
#region code-server customization
#region code-server
WORKDIR /
# remove code-server specific files to override with branded values.
# changes product images + app name
@ -68,4 +68,4 @@ RUN \
COPY code-server/media /app/code-server/src/browser/media
COPY code-server/root/etc/s6-overlay/s6-rc.d/svc-code-server/run /etc/s6-overlay/s6-rc.d/svc-code-server/run
#endregion
#endregion code-server

View File

@ -1,4 +1,7 @@
FROM oven/bun:1 as builder
FROM oven/bun:1 AS builder
ARG CI
ARG CI_COMMIT_PULL_REQUEST
COPY . /app
WORKDIR /app
@ -6,7 +9,7 @@ ENV NODE_ENV=production
RUN bun install --frozen-lockfile
RUN bun run --vite docs:build
FROM caddy:2.8.4-alpine as prod
FROM caddy:2.8.4-alpine AS prod
COPY --from=builder /app/docs/.vitepress/dist/ /arkanum-docs/
COPY Caddyfile /etc/caddy

View File

@ -19,6 +19,11 @@
<a href="https://ci.ocram85.com/arkanum/arkanum">
<img src="https://ci.ocram85.com/api/badges/arkanum/arkanum/status.svg" alt="Master Branch Build Status">
</a>
<a href="https://matrix.to/#/#arkanum:matrix.org" rel="noopener" target="_blank">
<img src="https://matrix.to/img/matrix-badge.svg" alt="Chat on Matrix">
</a>
<img alt="Matrix" src="https://img.shields.io/matrix/arkanum%3Amatrix.org">
</p>
## 🤖 Quickstart

View File

@ -1,5 +1,5 @@
function getItems(version) {
const ci = process.env.ci
const ci = process.env.CI
const pr = process.env.CI_COMMIT_PULL_REQUEST
let nver = undefined

View File

@ -19,6 +19,7 @@ function getGuide() {
{ text: 'Git', link: 'components/git' },
{ text: 'Arkanum CLI', link: 'components/arkanum-cli' },
{ text: 'FiraCode Font', link: 'components/firacode' },
{ text: 'Code Server', link: 'components/code-server' },
{ text: 'VSCode', link: 'components/vscode' },
],
},

View File

@ -0,0 +1,49 @@
<script setup>
import { withBase } from 'vitepress';
import { computed } from 'vue';
const props = defineProps({
Source: {
type: String,
required: true
},
Caption: {
type: String
}
})
const ImageSource = computed(() => {
return withBase(props.Source)
})
</script>
<template>
<div class="blog-header-container">
<img :src="ImageSource">
<p v-if="props.Caption">{{ props.Caption }}</p>
</div>
</template>
<style scoped>
.blog-header-container {
width: 100%;
margin: 24px 0;
}
.blog-header-container img {
max-width: 325px;
max-height: 325px;
margin: 12px auto;
border: 2px solid var(--vp-c-brand-soft);
border-radius: 12px;
/*box-shadow: -1px 5px 24px 12px var(--vp-c-brand-soft);*/
box-shadow: 0px 8px 16px var(--vp-c-brand-soft);
}
.blog-header-container p {
width: 80%;
margin: 0 auto;
text-align: center;
font-size: smaller;
}
</style>

View File

@ -4,6 +4,7 @@ import DefaultTheme from 'vitepress/theme'
import './style.css'
import Blog from './components/Blog.vue'
import BlogHeaderImage from './components/BlogHeaderImage.vue'
/** @type {import('vitepress').Theme} */
export default {
@ -15,5 +16,6 @@ export default {
},
enhanceApp({ app, router, siteData }) {
app.component('blog', Blog)
app.component('BlogHeaderImage', BlogHeaderImage)
},
}

View File

@ -0,0 +1,32 @@
# Code Server Customizations
## About
The Arkanum image itself depends on the underlying [coder/code-server](https://github.com/coder/code-server) project
and the container image provided by
[linxuserver/docker-code-server](https://github.com/linuxserver/docker-code-server). To be able to add features and
change the behaviour we need to customize either the code-server itself of the docker image creation.
These are the custimzations we added to build the `arkanum server` and the `arkanum-cli` :
## Bash Aliases
You can use the alias `summon` to interact with the code-server instance.
## Product Images
We replaces the product image files to math the arkanum branding. See the
[code-server/media](https://gitea.ocram85.com/arkanum/arkanum/src/branch/master/code-server/media) folder for the
used files.
## Application Name
The code-server command provides the ability to change it's name in the title other places.
We also use arkanum therefore.
## Referenced Source Files
::: code-group
<<< @/../Dockerfile#code-server{Dockerfile:line-numbers}
<<< @/../code-server/root/etc/s6-overlay/s6-rc.d/svc-code-server/run{bash:line-numbers}
:::

View File

@ -16,6 +16,9 @@ hero:
- theme: alt
text: Show Sources
link: https://gitea.ocram85.com/arkanum/arkanum
- theme: alt
text: 🧑‍🤝‍🧑💬 Join the Community
link: https://matrix.to/#/#arkanum:matrix.org
features:
- title: Beginner Friendly

View File

@ -0,0 +1,64 @@
---
aside: false
author: OCram85
title: 'Arkanum 1.6.0 is released'
tag: 'release'
image: 'blogCard.png'
date: '2024-08-01'
#featured: true
---
<!-- markdownlint-disable MD025 MD033 MD036 -->
# Arkanum 1.6.0 is released
<BlogHeaderImage Source='/blogCard.png' />
**Content**
[[TOC]]
## About
I'm happy to present the latest Arkanum release version `1.6.0`.
This release includes the following changes:
## Product Image Update
We updated the Arkanum images to be able to generate the favicons and PWA icons for the code-server image.
These are the curren image iterations:
| `pre v1` | `v1++` | `v1.6++` + `v2++` |
| :-----------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :----------------: |
| ![pre-v1](https://gitea.ocram85.com/arkanum/arkanum/raw/branch/master/assets/logo-pre1.png) | ![v1](https://gitea.ocram85.com/arkanum/arkanum/raw/branch/master/assets/logo-v1.png) | ![v1++](/logo.png) |
> [!TIP] 💡 TIP
> If you're interested in all variations, you can find the sources at
> Canva -> [Arkanum 2.0 Collection](https://www.canva.com/design/DAGMBuM5uTk/mIyXxRbPwS6ZiT7I-MVepQ/view?utm_content=DAGMBuM5uTk&utm_campaign=designshare&utm_medium=link&utm_source=editor)
## Starting a Matrix Space
We decided to use Matrix for building the Arkanum community.
Feel free to join the [public community space](https://matrix.to/#/#arkanum:matrix.org).
[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#arkanum:matrix.org)
We also think about hosting a _Discourse_ or _Apache Answer_ based forum whenever needed. This could help collecting
all useful community resources like discussions, FAQs, and guides without searching in a room history.
## Added Tools <Badge type="tip" text="v1.6.0++" />
- We added [lazygit](https://github.com/jesseduffield/lazygit) in arkanum-cli.
- We also added the bash alias `summon` for _code-server_.
## Dependencies
- Updated Code-Server to `v4.91.0`
- Updated dependencies used in WoodpeckerCI workflows.
## Changelog
<!--@include: ../../../CHANGELOG.md{3,15}-->

BIN
docs/public/blogCard.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

View File

@ -1,6 +1,6 @@
{
"name": "arkanum-docs",
"version": "1.5.3",
"version": "1.6.0",
"type": "module",
"repository": {
"type": "git",