19 Commits
1.4.0 ... 1.4.3

Author SHA1 Message Date
2a04aa00a8 Release Version 1.4.3
### Fixed

- Fixed package missing the cli module in some circumstances

### Changed

- Added the `body-file` output to the github action. `body_file` still exists but is aliased to `body-file`
2024-08-27 23:42:06 -07:00
fbcd178205 update changelog 2024-08-27 23:41:23 -07:00
c37387360b update docs 2024-08-27 23:39:31 -07:00
fe8c38f62f better debug logging 2024-08-27 23:04:34 -07:00
d8ba08cc6a fine, be that way 2024-08-27 22:59:59 -07:00
ad19a2b530 🙄 2024-08-27 22:56:19 -07:00
4f22d74721 run with markdown 2024-08-27 22:52:01 -07:00
a6259aa1b3 action self-test 2024-08-27 22:48:55 -07:00
aad894fa08 Add body-file output, alias body_file to it 2024-08-27 22:27:24 -07:00
e31a8d094e Redo workflow
why do I do this to myself
2024-08-27 21:18:50 -07:00
0ca8609bb7 Try to guess version from action ref 2024-08-27 01:42:29 -07:00
394cac155f Fix possible exclusion of yaclog.cli 2024-08-27 01:42:18 -07:00
4d57ef2fb0 fix deploy permissions 2024-08-27 01:03:09 -07:00
4626e25838 Release Version 1.4.2
### Fixed

- Fixed package failing to install without git history

### Added

- Added the ability to specify the changelog path in the action
2024-08-27 00:51:21 -07:00
5373cb9b48 Add ability to specify changelog path 2024-08-27 00:49:40 -07:00
e3fc69d305 minor action tweaks
(cherry picked from commit 73a5ae0f9b7e64f2c52d9928a9e3a7fc9d49555d)
2024-08-27 00:36:04 -07:00
d61208b583 Add pretend version when installing in action 2024-08-27 00:20:53 -07:00
2a39c69700 Setup pypi trusted publishing 2024-08-26 23:30:05 -07:00
7a8b3c7160 Release Version 1.4.1
### Fixed

- Fixed escape characters being included in github actions body file

### Added

- Added pypi tags for python 3.11 and 3.12
2024-08-24 21:25:46 -07:00
9 changed files with 260 additions and 155 deletions

149
.github/workflows/build.yml vendored Normal file
View File

@ -0,0 +1,149 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
name: build
on: [ push, pull_request ]
jobs:
test:
name: Test Python Module
runs-on: ubuntu-22.04
strategy:
matrix:
python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
click-version: [ "click~=8.0" ]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5.1.1
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8
python -m pip install ${{ matrix.click-version }}
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Install module
run: python -m pip install .
- name: Run Unit Tests
run: python -m unittest -v
test-action:
name: Test Github Action
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Get Changelog Information
uses: ./
id: yaclog-show
with:
changelog-path: 'tests/Test-Changelog.md'
- name: Copy Body File
run:
cp ${{ steps.yaclog-show.outputs.body-file }} body.md
- name: Fail
if: >
!(
steps.yaclog-show.outputs.name == '0.13.0 "Aquarius"' &&
steps.yaclog-show.outputs.header == '## 0.13.0 "Aquarius" - 1970-04-11 [YANKED]' &&
steps.yaclog-show.outputs.version == '0.13.0' &&
endsWith(steps.yaclog-show.outputs.changelog, 'tests/Test-Changelog.md') &&
hashFiles('body.md') == 'ad49b5c946b7d361db1c3dacc73de4f6222cca6272aab426786de168eede702b'
)
run: |
echo "Action self-test failed!"
echo "${{ toJSON(steps.yaclog-show.outputs) }}"
echo "${{ hashFiles('body.md') }}"
false
build:
name: Build Distribution
needs:
- test
- test-action
runs-on: ubuntu-22.04
outputs:
body-file: ${{ steps.yaclog-show.outputs.body-file }}
version-name: ${{ steps.yaclog-show.outputs.name }}
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5.1.1
with:
python-version: '3.12'
- name: Get Changelog Information
id: yaclog-show
uses: ./ # self-hosting!
- name: Install pypa/build
run: python -m pip install build --user
- name: Build a binary wheel and source tarball
run: python -m build --sdist --wheel --outdir dist/
- uses: actions/upload-artifact@v4
with:
name: python-distribution
path: dist/
compression-level: 0 # already compressed
publish-pypi:
name: Deploy to PyPI
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
needs: build
runs-on: ubuntu-22.04
environment:
name: Publish
url: https://pypi.org/project/yaclog/${{ github.ref_name }}
permissions:
id-token: write
steps:
- uses: actions/download-artifact@v4
with:
name: python-distribution
path: dist/
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
publish-github:
name: Deploy to Github
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
needs: build
runs-on: ubuntu-22.04
environment:
name: Publish
url: https://github.com/${{ github.repository }}/releases/tag/${{ github.ref_name }}
permissions:
contents: write
steps:
- uses: actions/download-artifact@v4
with:
name: python-distribution
path: dist/
- name: Publish to Github
run: >
gh release create ${{ github.ref_name }}
--notes-file "${{ needs.build.outputs.body-file }}"
--title "${{ needs.build.outputs.version-name }}"
dist/*
env:
GH_TOKEN: ${{ github.token }}

View File

@ -1,87 +0,0 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
name: build
on: [ push, pull_request ]
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
click-version: [ "click~=8.0" ]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5.1.1
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8
python -m pip install ${{ matrix.click-version }}
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Install module
run: python -m pip install .
- name: Run Unit Tests
run: python -m unittest -v
- name: Run Action
id: yaclog-show
uses: ./
deploy:
needs: test
runs-on: ubuntu-latest
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5.1.1
with:
python-version: '>=3.8'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install setuptools wheel twine
- name: Install pypa/build
run: python -m pip install build --user
- name: Build a binary wheel and source tarball
run: python -m build --sdist --wheel --outdir dist/
- name: Get version info
id: yaclog-show
uses: ./
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}
- name: Publish to Github
run: |
gh release create ${{ github.ref_name }} \
--notes-file "${{ steps.yaclog-show.outputs.body_file }}" \
--title "${{ steps.yaclog-show.outputs.name }}"
gh release upload ${{ github.ref_name }} dist/*
env:
GH_TOKEN: ${{ github.token }}

View File

@ -2,38 +2,71 @@
All notable changes to this project will be documented in this file
## Version 1.4.3 - 2024-08-28
### Fixed
- Fixed package missing the cli module in some circumstances
### Changed
- Added the `body-file` output to the github action. `body_file` still exists but is aliased to `body-file`
## Version 1.4.2 - 2024-08-27
### Fixed
- Fixed package failing to install without git history
### Added
- Added the ability to specify the changelog path in the action
## Version 1.4.1 - 2024-08-25
### Fixed
- Fixed escape characters being included in github actions body file
### Added
- Added pypi tags for python 3.11 and 3.12
## Version 1.4.0 - 2024-08-25
### Added
- added a github action to the repository. The action can create new releases and fetch version information. For mor information see the "Github Actions" page in the handbook
- Added a github action to the repository. The action can create new releases and fetch version information. For more information see the "Github Actions" page in the handbook
## Version 1.3.0 - 2024-08-08
### Added
- added a `--version` option to `yaclog show` that prints just the version number
- Added a `--version` option to `yaclog show` that prints just the version number
### Changed
- removed support for Click 7 as a dependency
- Removed support for Click 7 as a dependency
## Version 1.2.0 - 2024-04-16
### Added
- added the `-s` option to `yaclog release` to increment arbitrary version segments
- added the `-n` option to `yaclog release` to create a new release instead of releasing a new one
- added the `-y` option to `yaclog release` to answer "yes" to all confirmation dialogs. Use with caution!
- Added the `-s` option to `yaclog release` to increment arbitrary version segments
- Added the `-n` option to `yaclog release` to create a new release instead of releasing a new one
- Added the `-y` option to `yaclog release` to answer "yes" to all confirmation dialogs. Use with caution!
## Version 1.1.2 - 2022-12-29
### Changed
- yaclog now only tries to use git when invoked with a command that needs it, meaning most sub commands can now be used on systems without git
- Yaclog now only tries to use git when invoked with a command that needs it, meaning most sub commands can now be used on systems without git
## Version 1.1.1 - 2022-08-15

View File

@ -1,12 +1,13 @@
name: Yaclog
description: >
Get version information from a changelog, and optionally create a new release.
The `yaclog` command is made available for use in future steps.
description: Get version information from a changelog
branding:
icon: file-text
color: orange
inputs:
changelog-path:
description: "Path of the changelog markdown file"
markdown:
description: If outputs should be in markdown format or not
default: 'true'
@ -27,9 +28,12 @@ outputs:
version:
description: "The current version number. For example, `1.3.0`"
value: ${{ steps.yaclog-show.outputs.version }}
body_file:
body-file:
description: "Path to a temporary file containing the version body"
value: ${{ steps.yaclog-show.outputs.body_file }}
value: ${{ steps.yaclog-show.outputs.body-file }}
body_file:
description: "Alias for body-file"
value: ${{ steps.yaclog-show.outputs.body-file }}
changelog:
description: "Path to the entire changelog file."
value: ${{ steps.yaclog-show.outputs.changelog }}
@ -45,21 +49,21 @@ runs:
- name: Setup Yaclog
shell: bash
run: pipx install --python ${{ steps.setup-python.outputs.python-path }} ${{ github.action_path }}
run: |
[[ "$ACTION_REF" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] && export SETUPTOOLS_SCM_PRETEND_VERSION_FOR_YACLOG="$ACTION_REF"
pipx install --python ${{ steps.setup-python.outputs.python-path }} ${{ github.action_path }}
env:
ACTION_REF: ${{ github.action_ref }}
- name: Create New Release
shell: bash
if: ${{ inputs.release }}
run: yaclog release --yes --commit ${{ inputs.release }}
- name: Get Version Information
- name: Get Changelog Information
id: yaclog-show
shell: bash
run: |
yaclog show ---gh-actions ${{ inputs.markdown && '--markdown' }} >> "$GITHUB_OUTPUT"
# output like so:
# name=Version 1.3.0
# header=Version 1.3.0 - 2024-08-08
# version=1.3.0
# body_file={path to file containing version body}
# changelog={path to changelog}
run: >
yaclog ${{ inputs.changelog-path && format('--path {0}', inputs.changelog-path) }}
show ---gh-actions ${{ inputs.markdown && '--markdown' }}
| tee -a "$GITHUB_OUTPUT"

View File

@ -34,45 +34,6 @@ Tags are additional metadata added to a version header, denoted by all-caps text
## Example
```markdown
# Changelog
All notable changes to this project will be documented in this file.
## 0.13.0 "Aquarius" - 1970-04-11 [YANKED]
Yanked due to issues with oxygen tanks, currently investigating
### Added
- Extra propellant in preparation for future versions
### Changed
- Replaced Ken Mattingly
- Stirred oxygen tanks
## 0.12.0 "Intrepid" - 1969-11-14
### Added
- New ALSEP package for surface science
- Color cameras
- Surface rendezvous with Surveyor 3
### Fixed
- 1201/1202 alarm distracting crew during landing
### Known Issues
- Lightning strike during launch: No effect on performance
## 0.11.0 "Eagle" - 1969-07-20
Initial stable release
### Changed
- Fully fueled lander to allow landing on the lunar surface
```{literalinclude} ../../tests/Test-Changelog.md
:language: markdown
```

View File

@ -46,7 +46,7 @@ The most recent version name, equivalent to the output of `yaclog show --name`.
The entire header for the most recent version, equivalent to the output of `yaclog show --header`. For example, `Version 1.3.0 - 2024-08-08`
```
```{confval} body_file
```{confval} body-file
The path to a temporary file containing the body of the most recent version. Contents equivalent to `yaclog show --body`
```
@ -82,7 +82,7 @@ jobs:
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
run: |
gh release create {{ '${{ github.ref_name }}' }} \
--notes-file "{{ '${{ steps.yaclog.outputs.body_file }}' }}" \
--notes-file "{{ '${{ steps.yaclog.outputs.body-file }}' }}" \
--title "{{ '${{ steps.yaclog.outputs.name }}' }}"
env:
GH_TOKEN: {{ '${{ github.token }}' }}

View File

@ -22,6 +22,8 @@ classifiers = [
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Text Processing :: Markup :: Markdown",
"Topic :: Software Development :: Version Control :: Git",
"Topic :: Utilities"
@ -55,6 +57,7 @@ Changelog = "https://github.com/drewcassidy/yaclog/blob/main/CHANGELOG.md"
Docs = "https://yaclog.readthedocs.io/"
[tool.setuptools_scm]
fallback_version = "0.0.0"
[tool.setuptools.packages.find]
include = ["yaclog"]
include = ["yaclog*"]

40
tests/Test-Changelog.md Normal file
View File

@ -0,0 +1,40 @@
# Changelog
All notable changes to this project will be documented in this file.
## 0.13.0 "Aquarius" - 1970-04-11 [YANKED]
Yanked due to issues with oxygen tanks, currently investigating
### Added
- Extra propellant in preparation for future versions
### Changed
- Replaced Ken Mattingly
- Stirred oxygen tanks
## 0.12.0 "Intrepid" - 1969-11-14
### Added
- New ALSEP package for surface science
- Color cameras
- Surface rendezvous with Surveyor 3
### Fixed
- 1201/1202 alarm distracting crew during landing
### Known Issues
- Lightning strike during launch: No effect on performance
## 0.11.0 "Eagle" - 1969-07-20
Initial stable release
### Changed
- Fully fueled lander to allow landing on the lunar surface

View File

@ -16,6 +16,7 @@
import datetime
import os.path
from sys import stdout
import click
@ -91,7 +92,7 @@ def show(obj: Changelog, all_versions, markdown, mode, version_names, gh_actions
}
str_func = functions[mode]
kwargs = {'md': markdown, 'color': True}
kwargs = {'md': markdown, 'color': stdout.isatty()}
try:
if all_versions:
@ -115,13 +116,14 @@ def show(obj: Changelog, all_versions, markdown, mode, version_names, gh_actions
if gh_actions:
import tempfile
kwargs['color'] = False
all_modes = [ 'name', 'header', 'version' ]
outputs = [f'{mode}={sep.join([functions[mode](v, kwargs) for v in versions])}' for mode in all_modes]
click.echo('\n'.join(outputs))
body_fd, body_file = tempfile.mkstemp(text=True)
with os.fdopen(body_fd, 'w') as f:
f.write(sep.join([functions['body'](v, kwargs) for v in versions]))
click.echo(f'body_file={body_file}')
click.echo(f'body-file={body_file}')
click.echo(f'changelog={obj.path}')
return