initial commit

themes/hugo-theme-relearn/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [McShelby]

themes/hugo-theme-relearn/.github/actions/build_site/action.yaml

@@ -0,0 +1,19 @@
+name: Build site
+description: Builds the docs for later deploy on GitHub-Pages
+runs:
+  using: composite
+  steps:
+    - name: Setup Hugo
+      uses: peaceiris/actions-hugo@v3
+      with:
+        hugo-version: 'latest'
+
+    - name: Build docs
+      shell: bash
+      run: |
+        hugo --source ${GITHUB_WORKSPACE}/docs --destination ${GITHUB_WORKSPACE}/../public --cleanDestinationDir --environment github --theme ${GITHUB_WORKSPACE}
+
+    - name: Build exampleSite
+      shell: bash
+      run: |
+        hugo --source ${GITHUB_WORKSPACE}/exampleSite --destination ${GITHUB_WORKSPACE}/../public/exampleSite --environment github --theme ${GITHUB_WORKSPACE}

themes/hugo-theme-relearn/.github/actions/check_milestone/action.yaml

@@ -0,0 +1,110 @@
+name: Check milestone
+description: Checks if the given milestone and its according tag are valid to be released
+inputs:
+  milestone:
+    description: Milestone for this release
+    required: true
+  github_token:
+    description: Secret GitHub token
+    required: true
+outputs:
+  outcome:
+    description: Result of the check, success or failure
+    value: ${{ steps.outcome.outputs.outcome }}
+runs:
+  using: composite
+  steps:
+    - name: Get closed issues for milestone
+      id: closed_issues
+      uses: octokit/graphql-action@v2.x
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      with:
+        query: |
+          query {
+            search(first: 1, type: ISSUE, query: "repo:${{ github.repository_owner }}/${{ github.event.repository.name }} milestone:${{ env.MILESTONE }} state:closed") {
+              issueCount
+            }
+          }
+
+    - name: Get open issues for milestone
+      id: open_issues
+      uses: octokit/graphql-action@v2.x
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      with:
+        query: |
+          query {
+            search(first: 1, type: ISSUE, query: "repo:${{ github.repository_owner }}/${{ github.event.repository.name }} milestone:${{ env.MILESTONE }} state:open") {
+              issueCount
+            }
+          }
+
+    - name: Get current major version number
+      id: majorvers
+      uses: azarc-io/regex-property-action@master
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      with:
+        value: ${{ env.MILESTONE }}
+        regex: (\d+)\.\d+\.\d+
+        replacement: "$1"
+
+    - name: Get current minor version number
+      id: minorvers
+      uses: azarc-io/regex-property-action@master
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      with:
+        value: ${{ env.MILESTONE }}
+        regex: \d+\.(\d+)\.\d+
+        replacement: "$1"
+
+    - name: Get current patch version number
+      id: patchvers
+      uses: azarc-io/regex-property-action@master
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      with:
+        value: ${{ env.MILESTONE }}
+        regex: \d+\.\d+\.(\d+)
+        replacement: "$1"
+
+    - name: Check if releasenotes exists
+      id: releasenotes
+      shell: bash
+      run: |
+        if [ -f "docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md" ]; then
+          echo "file_exists=true" >> $GITHUB_OUTPUT
+        else
+          echo "file_exists=false" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Set outcome
+      id: outcome
+      shell: bash
+      run: |
+        if [[ \
+          ${{ fromJSON(steps.closed_issues.outputs.data).search.issueCount }} -gt 0 && \
+          ${{ fromJSON(steps.open_issues.outputs.data).search.issueCount }} -eq 0 && \
+          ${{ steps.releasenotes.outputs.file_exists == 'true' }} \
+        ]]; then
+          echo "outcome=success" >> $GITHUB_OUTPUT
+        else
+          echo "outcome=failure" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Log results and exit
+      shell: bash
+      run: |
+        echo outcome                : ${{ steps.outcome.outputs.outcome }}
+        echo has closed issues      : ${{ fromJSON(steps.closed_issues.outputs.data).search.issueCount > 0 }}
+        echo   count                : ${{ fromJSON(steps.closed_issues.outputs.data).search.issueCount }}
+        echo has all issues closed  : ${{ fromJSON(steps.open_issues.outputs.data).search.issueCount == 0 }}
+        echo   count                : ${{ fromJSON(steps.open_issues.outputs.data).search.issueCount }}
+        echo has releasenotes       : ${{ steps.releasenotes.outputs.file_exists }}
+        if [ "${{ steps.outcome.outputs.outcome }}" = "failure" ]; then
+          exit 1
+        fi

themes/hugo-theme-relearn/.github/actions/deploy_site/action.yaml

@@ -0,0 +1,17 @@
+name: Deploy site
+description: Deploys a built site on GitHub-Pages
+inputs:
+  github_token:
+    description: Secret GitHub token
+    required: true
+runs:
+  using: composite
+  steps:
+    - name: Deploy site
+      uses: peaceiris/actions-gh-pages@v3
+      env:
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+        GITHUB_WORKSPACE: ${{ github.workspace }}
+      with:
+        github_token: ${{ env.GITHUB_TOKEN }}
+        publish_dir: ${{ env.GITHUB_WORKSPACE }}/../public

themes/hugo-theme-relearn/.github/actions/release_milestone/action.yaml

@@ -0,0 +1,222 @@
+name: Release milestone
+description: Creates a release and tag out of a given milestone
+inputs:
+  milestone:
+    description: Milestone for this release
+    required: true
+  github_token:
+    description: Secret GitHub token
+    required: true
+runs:
+  using: composite
+  steps:
+    - name: Setup node
+      uses: actions/setup-node@v4
+      with:
+        node-version: '16'
+
+    - name: Setup git
+      shell: bash
+      env:
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      run: |
+        git config user.name "GitHub Actions Bot"
+        git config user.email "<>"
+
+    - name: Get current date
+      id: date
+      uses: Kaven-Universe/github-action-current-date-time@v1
+      with:
+        format: 'YYYY-MM-DD'
+
+    - name: Get current major version number
+      id: majorvers
+      uses: azarc-io/regex-property-action@master
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      with:
+        value: ${{ env.MILESTONE }}
+        regex: (\d+)\.\d+\.\d+
+        replacement: "$1"
+
+    - name: Get current minor version number
+      id: minorvers
+      uses: azarc-io/regex-property-action@master
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      with:
+        value: ${{ env.MILESTONE }}
+        regex: \d+\.(\d+)\.\d+
+        replacement: "$1"
+
+    - name: Get current patch version number
+      id: patchvers
+      uses: azarc-io/regex-property-action@master
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      with:
+        value: ${{ env.MILESTONE }}
+        regex: \d+\.\d+\.(\d+)
+        replacement: "$1"
+
+    - name: Get current padded patch version number
+      id: paddedpatchvers
+      shell: bash
+      run: |
+        NUM=$(printf "%03d" ${{ steps.patchvers.outputs.value }})
+        echo "value=$NUM" >> $GITHUB_OUTPUT
+
+    - name: Get next version number
+      id: nextvers
+      uses: WyriHaximus/github-action-next-semvers@v1
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      with:
+        version: ${{ env.MILESTONE }}
+
+    - name: Close milestone
+      uses: Akkjon/close-milestone@v2.1.0
+      continue-on-error: true
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      with:
+        milestone_name: ${{ env.MILESTONE }}
+
+    - name: Create temporary tag
+      shell: bash
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      run: |
+        git tag --message "" "$MILESTONE" || true
+        git push origin "$MILESTONE"      || true
+        git tag  --force --message "" "$MILESTONE"
+        git push --force origin "$MILESTONE"
+
+    - name: Update generator version
+      shell: bash
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+      run: |
+        echo -n "$MILESTONE" > layouts/partials/version.txt
+
+    - name: Generate english releasenotes
+      shell: bash
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+        GREN_GITHUB_TOKEN: ${{ inputs.github_token }}
+      run: |
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/_index.en.md
+
+    - name: Update releasenotes front matter
+      uses: surahmansada/file-regex-replace@v1
+      with:
+        regex: '(\ntitle = "Version )\d+\.\d+("\n.*\nweight = -)\d+(\n)'
+        replacement: "$1${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}$2${{ steps.minorvers.outputs.value }}$3"
+        include: docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
+
+    - name: Update releasenotes heading
+      uses: surahmansada/file-regex-replace@v1
+      with:
+        regex: '(.)[\n\r\s]*[\n\r]+##\s+.*?[\n\r][\n\r\s]*(.)'
+        replacement: "$1\n\n## ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}.0 (${{ steps.date.outputs.time }}) {#${{ steps.majorvers.outputs.value }}-${{ steps.minorvers.outputs.value }}-0}\n\n$2"
+        include: docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
+
+    - name: Generate piratish releasenotes
+      shell: bash
+      run: |
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/_index.pir.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.pir.md
+
+    - name: Generate english changelogs
+      shell: bash
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+        GREN_GITHUB_TOKEN: ${{ inputs.github_token }}
+      run: |
+        mkdir -p docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/_index.en.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" reverse=\"true\" %}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.en.md
+        npx github-release-notes@0.17.1 changelog --generate --changelog-filename docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md --tags "$MILESTONE"
+
+    - name: Generate piratish changelogs
+      shell: bash
+      run: |
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/_index.pir.md
+        echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.pir.md
+        echo -e "+++\n+++\n{{< piratify >}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.pir.md
+
+    - name: Read changelog
+      id: changelog_docs
+      uses: guibranco/github-file-reader-action-v2@latest
+      with:
+        path: docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md
+
+    - name: Write changelog to CHANGELOG.md
+      uses: surahmansada/file-regex-replace@v1
+      with:
+        regex: '(##\s+.*?[\n\r])[\n\r\s]*([\s\S]*)'
+        replacement: "${{ steps.changelog_docs.outputs.contents }}\n---\n\n$1\n$2"
+        include: CHANGELOG.md
+
+    - name: Set changelog for GitHub release
+      id: changelog_github
+      uses: azarc-io/regex-property-action@master
+      with:
+        value: ${{ steps.changelog_docs.outputs.contents }}
+        regex: '(##\s+.*?[\n\r])[\n\r\s]*([\s\S]*)'
+        replacement: "[★ What's new in this version ★](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/)\n\n$2"
+
+    - name: Commit updates
+      shell: bash
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      run: |
+        git add *
+        git commit --message "Ship tag $MILESTONE"
+        git push origin main
+
+    - name: Create final tags
+      shell: bash
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        MILESTONE_MAJOR: ${{ steps.majorvers.outputs.value }}
+        MILESTONE_MINOR: ${{ steps.minorvers.outputs.value }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      run: |
+        git tag  --force --message "" "$MILESTONE"
+        git push --force origin "$MILESTONE"
+        git tag --message "" "$MILESTONE_MAJOR.$MILESTONE_MINOR.x" || true
+        git push origin "$MILESTONE_MAJOR.$MILESTONE_MINOR.x"      || true
+        git tag  --force --message "" "$MILESTONE_MAJOR.$MILESTONE_MINOR.x"
+        git push --force origin "$MILESTONE_MAJOR.$MILESTONE_MINOR.x"
+        git tag --message "" "$MILESTONE_MAJOR.x" || true
+        git push origin "$MILESTONE_MAJOR.x"      || true
+        git tag  --force --message "" "$MILESTONE_MAJOR.x"
+        git push --force origin "$MILESTONE_MAJOR.x"
+        git tag --message "" "x" || true
+        git push origin "x"      || true
+        git tag  --force --message "" "x"
+        git push --force origin "x"
+
+    - name: Publish release
+      uses: ncipollo/release-action@v1
+      env:
+        MILESTONE: ${{ inputs.milestone }}
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      with:
+        body: |
+          ${{ steps.changelog_github.outputs.value }}
+        tag: ${{ env.MILESTONE }}
+
+    - name: Create next patch milestone
+      uses: WyriHaximus/github-action-create-milestone@v1
+      continue-on-error: true
+      env:
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+      with:
+        title: ${{ steps.nextvers.outputs.patch }}

themes/hugo-theme-relearn/.github/workflows/docs-build-deployment.yaml

@@ -0,0 +1,25 @@
+name: docs-build-deployment
+
+on:
+  push: # Build on all pushes but only deploy for main branch
+  workflow_dispatch: # Allow this task to be manually started (you'll never know)
+
+jobs:
+  deploy:
+    name: Run deploy
+    runs-on: ubuntu-latest
+    if: github.event_name != 'push' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          submodules: true  # Fetch Hugo themes (true OR recursive)
+          # fetch-depth: 0   # Fetch all history for .GitInfo and .Lastmod - not necessary for this repo
+
+      - name: Build site
+        uses: ./.github/actions/build_site
+
+      - name: Deploy site
+        uses: ./.github/actions/deploy_site
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

themes/hugo-theme-relearn/.github/workflows/docs-build.yaml

@@ -0,0 +1,21 @@
+name: docs-build
+
+on:
+  push: # Build on all pushes but only deploy for main branch
+  pull_request: # Build on all PRs regardless what branch
+  workflow_dispatch: # Allow this task to be manually started (you'll never know)
+
+jobs:
+  ci:
+    name: Run build
+    runs-on: ubuntu-latest
+    if: github.event_name != 'push' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          submodules: true  # Fetch Hugo themes (true OR recursive)
+          # fetch-depth: 0   # Fetch all history for .GitInfo and .Lastmod - not necessary for this repo
+
+      - name: Build site
+        uses: ./.github/actions/build_site

themes/hugo-theme-relearn/.github/workflows/version-release.yaml

@@ -0,0 +1,42 @@
+name: version-release
+
+on:
+  workflow_dispatch:
+    inputs:
+      milestone:
+        description: 'Milestone for this release'
+        required: true
+
+jobs:
+  release:
+    name: Run release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          submodules: true  # Fetch Hugo themes (true OR recursive)
+          # fetch-depth: 0   # Fetch all history for .GitInfo and .Lastmod - not necessary for this repo
+
+      - name: Check milestone
+        id: check
+        uses: ./.github/actions/check_milestone
+        with:
+          milestone: ${{ github.event.inputs.milestone }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create release
+        if: ${{ steps.check.outputs.outcome == 'success' }}
+        uses: ./.github/actions/release_milestone
+        with:
+          milestone: ${{ github.event.inputs.milestone }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      # We need to deploy the site again to show the updated changelog
+      - name: Build site
+        uses: ./.github/actions/build_site
+
+      - name: Deploy site
+        uses: ./.github/actions/deploy_site
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}