Skip to content

Commit

Permalink
Update README and add publish.yml workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhad6 committed Jun 17, 2024
1 parent c4aa3f3 commit c1c771e
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Publish

on:
release:
types: [published]

env:
POETRY_VERSION: "1.8.3"
PACKAGE_NAME: "paramview"

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install Poetry
run: pipx install poetry==${{ env.POETRY_VERSION }}

- name: Build package
run: poetry build

- name: Upload package artifact
uses: actions/upload-artifact@v4
with:
name: ${{ env.PACKAGE_NAME }}-release
path: dist

publish:
needs: build
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/project/${{ env.PACKAGE_NAME }}
permissions:
id-token: write
steps:
- uses: actions/download-artifact@v4
with:
name: ${{ env.PACKAGE_NAME }}-release
path: dist

- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# ParamView

[![PyPI Latest Release](https://img.shields.io/pypi/v/paramview)](https://pypi.org/project/paramview/)
[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/paramview)](https://pypi.org/project/paramview/)
[![License](https://img.shields.io/github/license/PainterQubits/paramview)](https://github.com/PainterQubits/paramview/blob/main/LICENSE)
[![CI](https://github.com/PainterQubits/paramview/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/paramview/actions/workflows/ci.yml)

GUI for viewing the contents of a ParamDB database.
Expand Down

0 comments on commit c1c771e

Please sign in to comment.