Skip to content
Publish package.

readme update #74

Sign in to view logs

readme update

readme update #74

Workflow file for this run

.github/workflows/publish.yml at 4ab3d18
name: Publish package.
on:
push:
branches:
- main
tags:
- '0.0.*'
paths:
- sbiax/**
- pyproject.toml
jobs:
test:
name: Test 🔍 package 🗂️
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: Setup 🛠️ Python 🐍
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install 🛠️ dependencies 📚
run: |
pip install --upgrade pip
pip install -e .
pip install --requirement=tests/requirements.txt
- name: Run ⏱️ tests 📊
run: pytest
build:
name: Build distribution 📦
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install pypa/build
run: >-
python3 -m
pip install
build
--user
- name: Build a binary wheel and a source tarball
run: python3 -m build
- name: Store the distribution packages
uses: actions/upload-artifact@v4
with:
name: python-package-distributions
path: dist/
# python-version: ${{ matrix.python-version }}
# name: python-package-distributions
# path: dist-py${{ matrix.python-version }}/
publish-to-pypi:
name: >-
Publish Python 🐍 distribution 📦 to PyPI
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
needs:
- build
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/sbiax # Replace <package-name> with your PyPI project name
permissions:
id-token: write # IMPORTANT: mandatory for trusted publishing
steps:
- name: Download all the dists
uses: actions/download-artifact@v4
with:
pattern: dist-* # !!
name: python-package-distributions
path: dist/
merge-multiple: true
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
github-release:
name: >-
Sign the Python 🐍 distribution 📦 with Sigstore
and upload them to GitHub Release
needs:
- publish-to-pypi
runs-on: ubuntu-latest
permissions:
contents: write # IMPORTANT: mandatory for making GitHub Releases
id-token: write # IMPORTANT: mandatory for sigstore
steps:
- name: Download all the dists
uses: actions/download-artifact@v4
with:
pattern: dist-* # !!
name: python-package-distributions
path: dist/
- name: Sign the dists with Sigstore
uses: sigstore/[email protected] #sigstore/[email protected]
with:
inputs: >-
./dist/*.tar.gz
./dist/*.whl
- name: Create GitHub Release
env:
GITHUB_TOKEN: ${{ github.token }}
run: >-
gh release create
'${{ github.ref_name }}'
--repo '${{ github.repository }}'
--notes ""
- name: Upload artifact signatures to GitHub Release
env:
GITHUB_TOKEN: ${{ github.token }}
# Upload to GitHub Release using the `gh` CLI.
# `dist/` contains the built packages, and the
# sigstore-produced signatures and certificates.
run: >-
gh release upload
'${{ github.ref_name }}' dist/**
--repo '${{ github.repository }}'
publish-to-testpypi:
name: Publish Python 🐍 distribution 📦 to TestPyPI
needs:
- build
runs-on: ubuntu-latest
environment:
name: testpypi
url: https://test.pypi.org/p/sbiax # url: https://test.pypi.org/p/<package-name>
permissions:
id-token: write # IMPORTANT: mandatory for trusted publishing
steps:
- name: Download all the dists
uses: actions/download-artifact@v4
with:
pattern: dist-* # !!
name: python-package-distributions
path: dist/
merge-multiple: true
- name: Publish distribution 📦 to TestPyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: https://test.pypi.org/legacy/
# name: Publish 📡 Python 🐍 distributions 📦
# on:
# push:
# branches:
# - main
# tags:
# - 0.0.*
# paths:
# - sbiax/**
# - pyproject.toml # Only if version changes!
# jobs:
# test:
# name: Test 🔍 package 🗂️
# runs-on: ubuntu-latest
# strategy:
# matrix:
# python-version: ["3.10", "3.11", "3.12"]
# steps:
# - uses: actions/checkout@v4
# - name: Setup 🛠️ Python 🐍
# uses: actions/setup-python@v5
# with:
# python-version: ${{ matrix.python-version }}
# - name: Install 🛠️ dependencies 📚
# run: |
# pip install --upgrade pip
# pip install -e .
# pip install --requirement=tests/requirements.txt
# - name: Run ⏱️ tests 📊
# run: pytest
# build:
# name: Build 🏗️ distributions 📦
# needs: [test]
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# - name: Setup 🛠️ Python 🐍
# uses: actions/setup-python@v5
# with:
# python-version: "3.12"
# - name: Build 🏗️ a source distribution 🗃️ and a binary wheel 🛞
# run: pipx run build --outdir=distributions
# - name: Upload 📤 the built distributions 📦
# uses: actions/upload-artifact@v4
# with:
# name: distributions-py${{ matrix.python-version }} # name: distributions
# path: distributions/
# publish-to-pypi:
# name: Publish 📡 Python 🐍 distributions 📦 to PyPI 🌐
# if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
# needs: [build]
# runs-on: ubuntu-latest
# environment:
# name: release
# url: https://pypi.org/p/sbiax
# permissions:
# id-token: write
# steps:
# - name: Download 📥 all the distributions 📦
# uses: actions/download-artifact@v4
# with:
# pattern: distributions-* #pattern: distributions
# path: distributions/
# merge-multiple: true
# - name: Publish 📡 distributions 📦 to PyPI 🌐
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# packages-dir: distributions/
# upload-to-github-release:
# name: Upload 📤 Python 🐍 distributions 📦 to GitHub Release 🚀
# needs: [publish-to-pypi]
# runs-on: ubuntu-latest
# permissions:
# id-token: write
# contents: write
# steps:
# - name: Download 📥 all the distributions 📦
# uses: actions/download-artifact@v4
# with:
# pattern: distributions
# path: distributions/
# merge-multiple: true
# - name: Sign 🔑 the distributions 📦 with Sigstore
# uses: sigstore/[email protected]
# with:
# inputs: >-
# ./distributions/*.tar.gz
# ./distributions/*.whl
# - name: Create GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# run: >-
# gh release create
# '${{ github.ref_name }}'
# --repo '${{ github.repository }}'
# --notes ""
# - name: Upload artifact signatures to GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# # Upload to GitHub Release using the `gh` CLI.
# # `dist/` contains the built packages, and the
# # sigstore-produced signatures and certificates.
# run: >-
# gh release upload
# '${{ github.ref_name }}' distributions/**
# --repo '${{ github.repository }}'
# publish-to-testpypi:
# name: Publish Python 🐍 distribution 📦 to TestPyPI
# needs:
# - build
# runs-on: ubuntu-latest
# environment:
# name: testpypi
# url: https://test.pypi.org/p/sbiax
# permissions:
# id-token: write # IMPORTANT: mandatory for trusted publishing
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# pattern: distributions-* #python-package-distributions-*
# path: distributions/
# merge-multiple: true
# - name: Publish distribution 📦 to TestPyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# repository-url: https://test.pypi.org/legacy/
# - name: Create 📂 GitHub Release 🚀
# env:
# GITHUB_TOKEN: ${{ github.token }}
# run: gh release --repo="${{ github.repository }}" create "${{ github.ref_name }}"
# - name: Upload 📤 distributions 📦 and signatures 🔏 to GitHub Release 🚀
# env:
# GITHUB_TOKEN: ${{ github.token }}
# run: gh release --repo="${{ github.repository }}" upload "${{ github.ref_name }}" distributions/**
# name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
# on: push
# jobs:
# build:
# name: Build distribution 📦
# runs-on: ubuntu-latest
# strategy:
# matrix:
# python-version: [, "3.9", "3.10", "3.11", "3.12"]
# steps:
# - uses: actions/checkout@v4
# with:
# persist-credentials: false
# - name: Set up Python ${{ matrix.python-version }}
# uses: actions/setup-python@v5
# with:
# python-version: ${{ matrix.python-version }}
# - name: Install pypa/build
# run: >-
# python3 -m
# pip install
# build
# --user
# - name: Build a binary wheel and a source tarball
# run: python3 -m build
# - name: Store the distribution packages
# uses: actions/upload-artifact@v4
# with:
# name: python-package-distributions-${{ matrix.python-version }}
# path: dist/
# publish-to-pypi:
# name: >-
# Publish Python 🐍 distribution 📦 to PyPI
# if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
# needs:
# - build
# runs-on: ubuntu-latest
# environment:
# name: pypi
# url: https://pypi.org/p/<package-name> # Replace <package-name> with your PyPI project name
# permissions:
# id-token: write # IMPORTANT: mandatory for trusted publishing
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# pattern: python-package-distributions-*
# path: dist/
# merge-multiple: true
# - name: Publish distribution 📦 to PyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# github-release:
# name: >-
# Sign the Python 🐍 distribution 📦 with Sigstore
# and upload them to GitHub Release
# needs:
# - publish-to-pypi
# runs-on: ubuntu-latest
# permissions:
# contents: write # IMPORTANT: mandatory for making GitHub Releases
# id-token: write # IMPORTANT: mandatory for sigstore
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# pattern: python-package-distributions-*
# path: dist/
# merge-multiple: true
# - name: Sign the dists with Sigstore
# uses: sigstore/[email protected]
# with:
# inputs: >-
# ./dist/*.tar.gz
# ./dist/*.whl
# - name: Create GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# run: >-
# gh release create
# "$GITHUB_REF_NAME"
# --repo "$GITHUB_REPOSITORY"
# --notes ""
# - name: Upload artifact signatures to GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# run: >-
# gh release upload
# "$GITHUB_REF_NAME" dist/**
# --repo "$GITHUB_REPOSITORY"
# publish-to-testpypi:
# name: Publish Python 🐍 distribution 📦 to TestPyPI
# needs:
# - build
# runs-on: ubuntu-latest
# environment:
# name: testpypi
# url: https://test.pypi.org/p/<package-name>
# permissions:
# id-token: write # IMPORTANT: mandatory for trusted publishing
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# pattern: python-package-distributions-*
# path: dist/
# merge-multiple: true
# - name: Publish distribution 📦 to TestPyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# repository-url: https://test.pypi.org/legacy/
# name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
# on: push
# jobs:
# build:
# name: Build distribution 📦
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# with:
# persist-credentials: false
# - name: Set up Python
# uses: actions/setup-python@v5
# with:
# python-version: "3.x"
# - name: Install pypa/build
# run: >-
# python3 -m
# pip install
# build
# --user
# - name: Build a binary wheel and a source tarball
# run: python3 -m build
# - name: Store the distribution packages
# uses: actions/upload-artifact@v4
# with:
# name: python-package-distributions
# path: dist/
# publish-to-pypi:
# name: >-
# Publish Python 🐍 distribution 📦 to PyPI
# if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
# needs:
# - build
# runs-on: ubuntu-latest
# environment:
# name: pypi
# url: https://pypi.org/p/<package-name> # Replace <package-name> with your PyPI project name
# permissions:
# id-token: write # IMPORTANT: mandatory for trusted publishing
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions
# path: dist/
# - name: Publish distribution 📦 to PyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# github-release:
# name: >-
# Sign the Python 🐍 distribution 📦 with Sigstore
# and upload them to GitHub Release
# needs:
# - publish-to-pypi
# runs-on: ubuntu-latest
# permissions:
# contents: write # IMPORTANT: mandatory for making GitHub Releases
# id-token: write # IMPORTANT: mandatory for sigstore
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions
# path: dist/
# - name: Sign the dists with Sigstore
# uses: sigstore/[email protected]
# with:
# inputs: >-
# ./dist/*.tar.gz
# ./dist/*.whl
# - name: Create GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# run: >-
# gh release create
# "$GITHUB_REF_NAME"
# --repo "$GITHUB_REPOSITORY"
# --notes ""
# - name: Upload artifact signatures to GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# # Upload to GitHub Release using the `gh` CLI.
# # `dist/` contains the built packages, and the
# # sigstore-produced signatures and certificates.
# run: >-
# gh release upload
# "$GITHUB_REF_NAME" dist/**
# --repo "$GITHUB_REPOSITORY"
# publish-to-testpypi:
# name: Publish Python 🐍 distribution 📦 to TestPyPI
# needs:
# - build
# runs-on: ubuntu-latest
# environment:
# name: testpypi
# url: https://test.pypi.org/p/<package-name>
# permissions:
# id-token: write # IMPORTANT: mandatory for trusted publishing
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions
# path: dist/
# - name: Publish distribution 📦 to TestPyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# repository-url: https://test.pypi.org/legacy/
# name: Publish package
# on:
# push:
# branches:
# - main
# tags:
# - '0.0.*'
# paths:
# - sbiax/**
# - pyproject.toml # Only if version changes!
# jobs:
# build:
# name: Build distribution 📦
# runs-on: ubuntu-latest
# strategy:
# matrix:
# python-version: ["3.10", "3.11", "3.12"] # Specify multiple Python versions
# steps:
# - uses: actions/checkout@v4
# - name: Set up Python
# uses: actions/setup-python@v5
# with:
# python-version: ${{ matrix.python-version }}
# - name: Install pypa/build
# run: python3 -m pip install --upgrade pip build
# - name: Build a binary wheel and a source tarball
# run: python3 -m build
# - name: Ensure dist/ exists
# run: mkdir -p dist/
# - name: Store the distribution packages
# uses: actions/upload-artifact@v4
# with:
# name: python-package-distributions-${{ matrix.python-version }}
# path: dist/
# publish-to-pypi:
# name: Publish Python 🐍 distribution 📦 to PyPI
# if: startsWith(github.ref, 'refs/tags/') # Only publish to PyPI on tag pushes
# needs: build
# runs-on: ubuntu-latest
# environment:
# name: pypi
# permissions:
# id-token: write # Mandatory for trusted publishing
# steps:
# - name: Download artifacts
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions-${{ matrix.python-version }}
# path: dist/
# - name: Publish distribution 📦 to PyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# github-release:
# name: Create GitHub Release with Sigstore
# needs: publish-to-pypi
# runs-on: ubuntu-latest
# permissions:
# contents: write # Required for creating GitHub Releases
# id-token: write # Required for sigstore
# steps:
# - name: Download artifacts
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions-${{ matrix.python-version }}
# path: dist/
# - name: Sign the dists with Sigstore
# uses: sigstore/[email protected] # uses: sigstore/[email protected]
# with:
# inputs: |
# ./dist/*.tar.gz
# ./dist/*.whl
# - name: Create GitHub Release
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: |
# gh release create '${{ github.ref_name }}' --repo '${{ github.repository }}' --notes ""
# - name: Upload artifact signatures to GitHub Release
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: |
# gh release upload '${{ github.ref_name }}' dist/** --repo '${{ github.repository }}'
# publish-to-testpypi:
# name: Publish Python 🐍 distribution 📦 to TestPyPI
# needs: build
# runs-on: ubuntu-latest
# environment:
# name: testpypi
# permissions:
# id-token: write # Mandatory for trusted publishing
# steps:
# - name: Download artifacts
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions-${{ matrix.python-version }}
# path: dist/
# - name: Publish distribution 📦 to TestPyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# repository-url: https://test.pypi.org/legacy/
# name: Publish package
# on:
# push:
# branches:
# - main
# tags:
# - '0.0.*'
# paths:
# - sbiax/**
# - pyproject.toml # Only if version changes!
# jobs:
# build:
# name: Build distribution 📦
# runs-on: ubuntu-latest
# strategy:
# matrix:
# python-version: ["3.10", "3.11", "3.12"]
# steps:
# - uses: actions/checkout@v4
# - name: Set up Python
# uses: actions/setup-python@v5
# with:
# python-version: ${{ matrix.python-version }}
# - name: Install pypa/build
# run: python3 -m pip install --upgrade pip build
# - name: Build a binary wheel and a source tarball
# run: python3 -m build
# - name: Ensure dist/ exists
# run: mkdir -p dist/
# - name: Store the distribution packages
# uses: actions/upload-artifact@v4
# with:
# name: python-package-distributions-${{ matrix.python-version }}
# path: dist/
# publish-to-pypi:
# name: Publish Python 🐍 distribution 📦 to PyPI
# if: startsWith(github.ref, 'refs/tags/')
# needs: build
# runs-on: ubuntu-latest
# environment:
# name: pypi
# permissions:
# id-token: write
# steps:
# - name: Publish distribution 📦 to PyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# github-release:
# name: Create GitHub Release with Sigstore
# needs: publish-to-pypi
# runs-on: ubuntu-latest
# permissions:
# contents: write
# id-token: write
# steps:
# - name: Sign the dists with Sigstore
# uses: sigstore/[email protected]
# with:
# inputs: |
# ./dist/*.tar.gz
# ./dist/*.whl
# - name: Create GitHub Release
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: |
# gh release create '${{ github.ref_name }}' --repo '${{ github.repository }}' --notes ""
# - name: Upload artifact signatures to GitHub Release
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: |
# gh release upload '${{ github.ref_name }}' dist/** --repo '${{ github.repository }}'
# publish-to-testpypi:
# name: Publish Python 🐍 distribution 📦 to TestPyPI
# needs: build
# runs-on: ubuntu-latest
# environment:
# name: testpypi
# permissions:
# id-token: write
# steps:
# - name: Publish distribution 📦 to TestPyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# repository-url: https://test.pypi.org/legacy/
# name: Publish package.
# on:
# push:
# branches:
# - main
# tags:
# - '0.0.*'
# paths:
# - sbiax/**
# - pyproject.toml # Only if version changes!
# jobs:
# build:
# name: Build distribution 📦
# runs-on: ubuntu-latest
# strategy:
# matrix:
# python-version: ["3.10", "3.11", "3.12"] # Specify multiple Python versions
# steps:
# - uses: actions/checkout@v4
# - name: Set up Python
# uses: actions/setup-python@v5
# with:
# python-version: ${{ matrix.python-version }}
# - name: Install pypa/build
# run: >-
# python3 -m
# pip install
# build
# --user
# - name: Build a binary wheel and a source tarball
# run: python3 -m build
# - name: Ensure dist/ exists
# run: test -d dist/ || mkdir dist/
# - name: Store the distribution packages
# uses: actions/upload-artifact@v4
# with:
# # name: python-package-distributions-${{ matrix.python-version }}
# path: dist/
# # jobs:
# # build:
# # name: Build distribution 📦
# # runs-on: ubuntu-latest
# # steps:
# # - uses: actions/checkout@v4
# # - name: Set up Python
# # uses: actions/setup-python@v5
# # with:
# # python-version: ["3.10", "3.11", "3.12"]
# # - name: Install pypa/build
# # run: >-
# # python3 -m
# # pip install
# # build
# # --user
# # - name: Build a binary wheel and a source tarball
# # run: python3 -m build
# # - name: Store the distribution packages
# # uses: actions/upload-artifact@v4
# # with:
# # name: python-package-distributions
# # path: dist/
# publish-to-pypi:
# name: >-
# Publish Python 🐍 distribution 📦 to PyPI
# if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
# needs:
# - build
# runs-on: ubuntu-latest
# environment:
# name: pypi
# url: https://pypi.org/p/sbiax # Replace <package-name> with your PyPI project name
# permissions:
# id-token: write # IMPORTANT: mandatory for trusted publishing
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions
# path: dist/
# - name: Publish distribution 📦 to PyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# github-release:
# name: >-
# Sign the Python 🐍 distribution 📦 with Sigstore
# and upload them to GitHub Release
# needs:
# - publish-to-pypi
# runs-on: ubuntu-latest
# permissions:
# contents: write # IMPORTANT: mandatory for making GitHub Releases
# id-token: write # IMPORTANT: mandatory for sigstore
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions
# path: dist/
# - name: Sign the dists with Sigstore
# uses: sigstore/[email protected]
# with:
# inputs: >-
# ./dist/*.tar.gz
# ./dist/*.whl
# - name: Create GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# run: >-
# gh release create
# '${{ github.ref_name }}'
# --repo '${{ github.repository }}'
# --notes ""
# - name: Upload artifact signatures to GitHub Release
# env:
# GITHUB_TOKEN: ${{ github.token }}
# # Upload to GitHub Release using the `gh` CLI.
# # `dist/` contains the built packages, and the
# # sigstore-produced signatures and certificates.
# run: >-
# gh release upload
# '${{ github.ref_name }}' dist/**
# --repo '${{ github.repository }}'
# publish-to-testpypi:
# name: Publish Python 🐍 distribution 📦 to TestPyPI
# needs:
# - build
# runs-on: ubuntu-latest
# environment:
# name: testpypi
# url: https://test.pypi.org/p/sbiax # url: https://test.pypi.org/p/<package-name>
# permissions:
# id-token: write # IMPORTANT: mandatory for trusted publishing
# steps:
# - name: Download all the dists
# uses: actions/download-artifact@v4
# with:
# name: python-package-distributions
# path: dist/
# - name: Publish distribution 📦 to TestPyPI
# uses: pypa/gh-action-pypi-publish@release/v1
# with:
# repository-url: https://test.pypi.org/legacy/