Skip to content
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.

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

feat: add versioning strategy #81

Merged
merged 3 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/hugo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.128.2
HUGO_VERSION: 0.136.5
steps:
- name: Install Hugo CLI
run: |
Expand Down
31 changes: 31 additions & 0 deletions docs/content/versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Versioning Strategy
geekdocNav: true
geekdocAnchor: true
---

Each library member is released using a [CalVer](https://calver.org/) tagging strategy.
The strategy is as follows:

```text
library/path/YYYY.0M.P-modifier
```

Where:

- `YYYY` is the year of the release.
- `0M` is the zero-padded month of the release.
- `P` is the patch number of the release, starting at zero.
- `modifier` is an optional modifier, such as `alpha`, `beta`, or `rc`.

## Changes

Consumers may expect breaking changes between year and month releases but not between patch releases.

## Example

For example, the October 2024 release of the library member `alz` in the `platform/alz` directory would be tagged as: `platform/alz/2021.10.0`.

## Latest

The latest release of a the `platform/alz` member will be marked as latest for the repository.
2 changes: 2 additions & 0 deletions docs/data/menu/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ main:
- name: Home
ref: /
icon: gdoc_home
- name: Versioning
ref: /versioning
- name: Assets
ref: /assets
- name: Clients
Expand Down
1 change: 1 addition & 0 deletions docs/themes/hugo-geekdoc/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
2 changes: 1 addition & 1 deletion docs/themes/hugo-geekdoc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Geekdoc

[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)
[![Hugo Version](https://img.shields.io/badge/hugo-0.112-blue.svg)](https://gohugo.io)
[![Hugo Version](https://img.shields.io/badge/hugo-0.124-blue.svg)](https://gohugo.io)
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)
Expand Down
2 changes: 1 addition & 1 deletion docs/themes/hugo-geekdoc/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.47.0
v1.1.0
428 changes: 224 additions & 204 deletions docs/themes/hugo-geekdoc/data/assets.json

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions docs/themes/hugo-geekdoc/eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import eslint from "@eslint/js";
import globals from "globals";
import babelParser from "@babel/eslint-parser";
import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";

export default [
eslint.configs.recommended,
{
languageOptions: {
globals: {
...globals.browser,
},
parser: babelParser,
ecmaVersion: 2022,
sourceType: "module",
parserOptions: {
requireConfigFile: false,
},
},
},
eslintPluginPrettierRecommended,
];
2 changes: 1 addition & 1 deletion docs/themes/hugo-geekdoc/layouts/partials/language.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{ if .Site.IsMultiLingual }}
{{ if hugo.IsMultilingual }}
<span class="gdoc-language">
<ul class="gdoc-language__selector" role="button" aria-pressed="false" tabindex="0">
<li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@
{{- end }}

{{- /* Facebook Page Admin ID for Domain Insights */}}
{{- with .Site.Social.facebook_admin }}
{{- with .Site.Params.facebook_admin }}
<meta property="fb:admins" content="{{ . }}" />
{{- end }}
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
{{- with partial "utils/description" . }}
<meta name="twitter:description" content="{{ . | plainify | htmlUnescape | chomp }}" />
{{- end }}
{{- with .Site.Social.twitter -}}
{{- with .Site.Params.twitter -}}
<meta name="twitter:site" content="@{{ . }}" />
{{- end }}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/themes/hugo-geekdoc/static/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/themes/hugo-geekdoc/static/favicon/favicon-48x48.png
Binary file modified docs/themes/hugo-geekdoc/static/favicon/mstile-144x144.png
Binary file modified docs/themes/hugo-geekdoc/static/favicon/mstile-150x150.png
Binary file modified docs/themes/hugo-geekdoc/static/favicon/mstile-310x150.png
Binary file modified docs/themes/hugo-geekdoc/static/favicon/mstile-310x310.png
Binary file modified docs/themes/hugo-geekdoc/static/favicon/mstile-70x70.png
Binary file modified docs/themes/hugo-geekdoc/static/fonts/GeekdocIcons.woff
Binary file not shown.
Binary file modified docs/themes/hugo-geekdoc/static/fonts/GeekdocIcons.woff2
Binary file not shown.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*!
Embeddable Minimum Strictly-Compliant Promises/A+ 1.1.1 Thenable
Copyright (c) 2013-2014 Ralf S. Engelschall (http://engelschall.com)
Licensed under The MIT License (http://opensource.org/licenses/MIT)
*/

/*! Bezier curve function generator. Copyright Gaetan Renaudeau. MIT License: http://en.wikipedia.org/wiki/MIT_License */

/*! Runge-Kutta spring physics function generator. Adapted from Framer.js, copyright Koen Bok. MIT License: http://en.wikipedia.org/wiki/MIT_License */

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading