s+,releaser,ci(build): implement #20

s+: add new constants and change version print
meta: add releaser.py
ci(build): seperate auto and manual + use releaser
This commit is contained in:
Mark Joshwel 2023-09-04 15:47:07 +00:00
parent 8af887a66c
commit e38d9d8bff
4 changed files with 167 additions and 9 deletions

View file

@ -0,0 +1,60 @@
name: automated tagged release with slsa 3 compliance
on:
push:
tags:
- '*'
jobs:
build:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
permissions:
contents: write
outputs:
hashes: ${{ steps.hash.outputs.hashes }}
steps:
- name: checkout
uses: actions/checkout@v3
- name: install devbox
uses: jetpack-io/devbox-install-action@v0.3.0
- name: install dependencies
run: devbox run poetry install
- name: run releaser.py
run: devbox run python releaser.py
- name: build project
id: build
run: devbox run poetry build
- name: duplicate non-versioned wheel
run: cp dist/surplus-*.whl dist/surplus-latest-py3-none-any.whl
- name: generate provenance subjects
id: hash
run: |
cd dist
HASHES=$(sha256sum * | base64 -w0)
echo "hashes=$HASHES" >> "$GITHUB_OUTPUT"
- name: release
uses: softprops/action-gh-release@v0.1.15
if: startsWith(github.ref, 'refs/tags/')
with:
files: |
dist/*.whl
provenance:
needs: [build]
permissions:
actions: read
id-token: write
contents: write
uses: slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@v1.6.0
with:
base64-subjects: "${{ needs.build.outputs.hashes }}"
upload-assets: true

View file

@ -1,9 +1,7 @@
name: release with slsa 3 compliance name: manual release with slsa 3 compliance
on: on:
push: workflow_dispatch:
tags:
- '*'
jobs: jobs:
build: build:
@ -17,13 +15,16 @@ jobs:
- name: checkout - name: checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: install devbox - name: install devbox
uses: jetpack-io/devbox-install-action@v0.3.0 uses: jetpack-io/devbox-install-action@v0.3.0
- name: install dependencies - name: install dependencies
run: devbox run poetry install run: devbox run poetry install
- name: install dependencies - name: run releaser.py
run: devbox run python releaser.py
- name: build project
id: build id: build
run: devbox run poetry build run: devbox run poetry build

84
releaser.py Normal file
View file

@ -0,0 +1,84 @@
"""
surplus: Google Maps Plus Code to iOS Shortcuts-like shareable text
-------------------------------------------------------------------
by mark <mark@joshwel.co>
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <http://unlicense.org/>
"""
from datetime import datetime, timedelta, timezone
from pathlib import Path
from subprocess import run
# NOTE: change this if surplus has moved
path_surplus = Path(__file__).parent.joinpath("./surplus/surplus.py")
build_time = datetime.now(timezone(timedelta(hours=8))) # using SGT
insert_build_branch: str = run(
"git rev-parse --abbrev-ref HEAD", capture_output=True, text=True, shell=True
).stdout.strip("\n")
insert_build_commit: str = run(
"git rev-parse HEAD", capture_output=True, text=True, shell=True
).stdout.strip("\n")
insert_build_datetime: str = repr(build_time).replace("datetime.", "")
# NOTE: change this if the respective lines in surplus.py have changed
targets: list[tuple[str, str]] = [
(
'VERSION_SUFFIX: Final[str] = "-local"',
'VERSION_SUFFIX: Final[str] = ""',
),
(
'BUILD_BRANCH: Final[str] = "future"',
f'BUILD_BRANCH: Final[str] = "{insert_build_branch}"',
),
(
'BUILD_COMMIT: Final[str] = "latest"',
f'BUILD_COMMIT: Final[str] = "{insert_build_commit}"',
),
(
"BUILD_DATETIME: Final[datetime] = datetime.now(timezone(timedelta(hours=8))) # using SGT",
f"BUILD_DATETIME: Final[datetime] = {insert_build_datetime}",
),
]
def main() -> int:
assert path_surplus.is_file() and path_surplus.exists(), f"{path_surplus} not found"
source_surplus: str = path_surplus.read_text(encoding="utf-8")
for old, new in targets:
print(f"new: {new}\nold: {old}\n")
source_surplus = source_surplus.replace(old, new)
path_surplus.write_text(source_surplus, encoding="utf-8")
return 0
if __name__ == "__main__":
exit(main())

View file

@ -31,6 +31,7 @@ For more information, please refer to <http://unlicense.org/>
from argparse import ArgumentParser from argparse import ArgumentParser
from collections import OrderedDict from collections import OrderedDict
from datetime import datetime, timedelta, timezone
from enum import Enum from enum import Enum
from sys import stderr, stdout from sys import stderr, stdout
from typing import ( from typing import (
@ -56,7 +57,11 @@ from pluscodes.openlocationcode import ( # type: ignore # isort: skip
# constants # constants
VERSION: Final[tuple[int, int, int]] = (2, 0, 0) VERSION: Final[tuple[int, int, int]] = (2, 1, 0)
VERSION_SUFFIX: Final[str] = "-local"
BUILD_BRANCH: Final[str] = "future"
BUILD_COMMIT: Final[str] = "latest"
BUILD_DATETIME: Final[datetime] = datetime.now(timezone(timedelta(hours=8))) # using SGT
USER_AGENT: Final[str] = "surplus" USER_AGENT: Final[str] = "surplus"
SHAREABLE_TEXT_LINE_0_KEYS: Final[tuple[str, ...]] = ( SHAREABLE_TEXT_LINE_0_KEYS: Final[tuple[str, ...]] = (
"emergency", "emergency",
@ -1062,8 +1067,16 @@ def cli() -> int:
behaviour = handle_args() behaviour = handle_args()
print( print(
f"surplus version {'.'.join([str(v) for v in VERSION])}" f"surplus version {'.'.join([str(v) for v in VERSION])}{VERSION_SUFFIX}"
+ (f", debug mode" if behaviour.debug else ""), + (f", debug mode" if behaviour.debug else "")
+ (
(
f" ({BUILD_COMMIT[:10]}@{BUILD_BRANCH}, "
f'{BUILD_DATETIME.strftime("%a %d %b %Y %H:%M:%S %z")})'
)
if behaviour.debug or behaviour.version_header
else ""
),
file=behaviour.stdout if behaviour.version_header else behaviour.stderr, file=behaviour.stdout if behaviour.version_header else behaviour.stderr,
) )