Skip to content

Commit c16a7fe

Browse files
committed
docs(README): remove examples & add redirect to docs website
1 parent 9be48d5 commit c16a7fe

File tree

1 file changed

+6
-51
lines changed

1 file changed

+6
-51
lines changed

README.md

Lines changed: 6 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,12 @@
1-
# Python Semantic Release - Upload to GitHub Release Action
1+
# Python Semantic Release - Publish Action
22

33
This GitHub Action runs `semantic-release publish` using
4-
[`python-semantic-release`](https://github.com/python-semantic-release/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.
4+
[`python-semantic-release`](https://pypi.org/project/python-semantic-release/).
5+
6+
Full usage information and examples for this GitHub Action is hosted on
7+
[Python Semantic Release - ReadTheDocs](https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html)
8+
website.
89

910
> **WARNING**: This Action is intended to be used in conjunction with Python
1011
> Semantic Release configuration of the same version! Using this Action with
1112
> a different version of Python Semantic Release may result in unexpected errors.
12-
13-
## Example usage
14-
15-
```yaml
16-
name: CI/CD
17-
18-
on:
19-
push:
20-
branches:
21-
- main
22-
23-
jobs:
24-
release:
25-
runs-on: ubuntu-latest
26-
concurrency: release
27-
28-
permissions:
29-
id-token: write
30-
31-
steps:
32-
- uses: actions/checkout@v4
33-
with:
34-
fetch-depth: 0
35-
36-
- name: Python Semantic Release
37-
id: release
38-
uses: python-semantic-release/[email protected]
39-
with:
40-
github_token: ${{ secrets.GITHUB_TOKEN }}
41-
# <other options here>
42-
43-
- name: Publish package to PyPI
44-
uses: pypa/gh-action-pypi-publish@v1
45-
if: steps.release.outputs.released == 'true'
46-
47-
- name: Publish package to GitHub Release
48-
uses: python-semantic-release/[email protected]
49-
if: steps.release.outputs.released == 'true'
50-
with:
51-
github_token: ${{ secrets.GITHUB_TOKEN }}
52-
tag: ${{ steps.release.outputs.tag }}
53-
```
54-
55-
## Options
56-
57-
See [action.yml](./action.yml) for a description of the available options.

0 commit comments

Comments
 (0)