Skip to content

Commit 9e10d6a

Browse files
committed
docs: update README & LICENSE info
1 parent 97ca27c commit 9e10d6a

File tree

3 files changed

+12
-18
lines changed

3 files changed

+12
-18
lines changed

CHANGELOG.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2023-present Bernard Cooke
3+
Copyright (c) 2023-present python-semantic-release/team
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@
22

33
This GitHub Action runs `semantic-release publish` using
44
[`python-semantic-release`](https://github.com/python-semantic-release/python-semantic-release).
5-
Full documentation is available in the [documentation](https://python-semantic-release.readthedocs.io/en/latest/)
6-
for Python Semantic Release.
5+
Full documentation is available in the
6+
[documentation](https://python-semantic-release.readthedocs.io/en/latest/) for Python
7+
Semantic Release.
78

8-
**NOTE**: This Action is compatible only with Python Semantic Release v8 or higher.
9+
> **WARNING**: This Action is intended to be used in conjunction with Python
10+
> Semantic Release configuration of the same version! Using this Action with
11+
> a different version of Python Semantic Release may result in unexpected errors.
912
1013
## Example usage
1114

1215
```yaml
13-
---
14-
name: CI
16+
name: CI/CD
1517

1618
on:
1719
push:
@@ -23,30 +25,27 @@ jobs:
2325
runs-on: ubuntu-latest
2426
concurrency: release
2527

26-
# NOTE: this enables trusted publishing.
27-
# See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1#trusted-publishing
28-
# and https://blog.pypi.org/posts/2023-04-20-introducing-trusted-publishers/
2928
permissions:
3029
id-token: write
3130

3231
steps:
33-
- uses: actions/checkout@v3
32+
- uses: actions/checkout@v4
3433
with:
3534
fetch-depth: 0
3635

3736
- name: Python Semantic Release
3837
id: release
39-
uses: python-semantic-release/python-semantic-release@v8.0.x
38+
uses: python-semantic-release/python-semantic-release@v8.6.0
4039
with:
4140
github_token: ${{ secrets.GITHUB_TOKEN }}
4241
# <other options here>
4342

4443
- name: Publish package to PyPI
45-
uses: pypa/gh-action-pypi-publish@release/v1
44+
uses: pypa/gh-action-pypi-publish@v1
4645
if: ${{ steps.release.outputs.released }} == 'true'
4746

4847
- name: Publish package to GitHub Release
49-
uses: python-semantic-release/upload-to-gh-release@main
48+
uses: python-semantic-release/upload-to-gh-release@v8.6.0
5049
if: ${{ steps.release.outputs.released }} == 'true'
5150
with:
5251
github_token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)