From cb3ddf19093f4a4091bee03d9268e7c90fb65b97 Mon Sep 17 00:00:00 2001 From: irkode Date: Tue, 20 Aug 2024 12:28:21 +0200 Subject: [PATCH] add update README, fix target folder --- .github/workflows/build.yml | 11 ++++++----- README.md | 21 +++++++++++++++------ 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b2d36d2..06867d2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -49,7 +49,6 @@ jobs: # get list of Bulma Releases $BulmaReleases = Invoke-RestMethod -FollowRelLink -Uri "$($Env:BULMA_URL)/releases?per_page=100" | %{$_}| ForEach-Object { if ($_.tag_name -and (-Not ($_.draft -and $_.prerelease))) { - Write-Output "found bulma release: $tag_name" [PSCustomObject]@{ release = [version]$_.tag_name known = [bool]$($Tags -contains $_.tag_name) @@ -71,12 +70,13 @@ jobs: [void](Test-Path .\assets -PathType Container -ErrorAction Stop) Expand-Archive -LiteralPath $BulmaRelease.archive -DestinationPath .\assets if (Test-Path .\assets\__MACOSX) { Remove-Item .\assets\__MACOSX -ErrorAction SilentlyContinue -Recurse } + Rename-Item .\assets\$bulmaFolder "bulma" + [void](Test-Path ./assets/bulma -PathType Container -ErrorAction Stop) if ((Get-ChildItem .\assets).Count -ne 1) { Write-Error "Unknown Bulma archive content found (expected 'bulma' only):" Get-ChildItem .\assets | Out-Host Write-Error "Aborting - please check" } - [void](Test-Path ./assets/bulma -PathType Container -ErrorAction Stop) echo "BULMA_RELEASE=$($BulmaRelease.release)" | Out-File $Env:GITHUB_ENV -Append -Encoding utf8 echo "BULMA_ARCHIVE=$($BulmaRelease.archive)" | Out-File $Env:GITHUB_ENV -Append -Encoding utf8 Write-Output "download successful: $($BulmaRelease.archive)" @@ -91,11 +91,12 @@ jobs: $BulmaArchive = "$ENV:BULMA_ARCHIVE" $cwd = ($pwd.Path -replace "\\","\\") + "\\" (Get-ChildItem . -recurse).FullName -replace $cwd, ""|sort - git checkout -b "bulma-$BulmaRelease" + $bulmaBranch = "bulma-$BulmaRelease" + git checkout -b $bulmaBranch git add assets .github git commit -m "add Bulma $BulmaRelease" - git push + git push --set-upstream origin $bulmaBranch git tag -a "$BulmaRelease" -m "packed Bulma release $BulmaRelease" git push --tags git checkout main - git branch -D "bulma-$BulmaRelease" + git branch -D $bulmaBranch diff --git a/README.md b/README.md index b71fec0..852f830 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ Bulma releases packaged for use with Hugo as module or using git. ## Disclaimer This is just a brute force repacking Bulma release for using as a Hugo module. -- There's no stuff like verification and testing. + +- There's no stuff like verification and testing. - delivered as-is, no guarantee no warranty - No Bulma support here @@ -25,7 +26,7 @@ anything regarding the packaging may be addressed here [Bulma 4 Hugo](https://gi ## Use Bulma 4 Hugo in your Hugo project -Set up a you Hugo site and change to its site root folder. +Set up a you Hugo site and cd to site root folder. Add _Bulma 4 Hugo_ to your site using one of the below methods @@ -90,14 +91,22 @@ Add the Theme to your site configuration ## Use Bulma -The files are stored in Hugo `/assets` folder. Available variants depend on Bulma release version. +After installing Bulma 4 Hugo you may refer to the Bulma css, scss files using `/assets/bulma` + +Just follow the [Official Bulma documentation](https://bulma.io/). + +In general you will use [Hugo Asset Management](https://gohugo.io/categories/asset-management/) to add Bulma tzo your site. -## Version and Update +## Releases _Bulma 4 Hugo_ follows the Bulma release scheme. So version numbers are same. Only tagged releases are available. -We automatically pack new versions of Bulma shortly after release. +New Bulma releases should be added shortly after published. + +## Licensing + +This is just a repack of Bulma. The packer itself is [MIT licensed](./LICENSE) -## Included Files +For Bulma Licensing terms consult the Bulma Documentation at [Bulma Licensing and Copyright](https://github.com/jgthms/bulma#copyright-and-license-)