Skip to content

Commit

Permalink
Use environments for additional deployment safety
Browse files Browse the repository at this point in the history
Signed-off-by: Keith Battocchi <kebatt@microsoft.com>
  • Loading branch information
kbattocchi committed Apr 24, 2024
1 parent 11cc33f commit 4dde5b0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ jobs:
uses: ./.github/workflows/publish-package.yml
with:
publish: false
repository: testpypi
environment: test
# don't have access to env context here for some reason
ref: ${{ github.event_name == 'workflow_dispatch' && inputs.ref || null }}
# can't use env context here so need to duplicate expression, but these are true boolean values so don't need extra string logic
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/publish-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,12 @@ jobs:

publish-docs:
name: Publish documentation
runs-on: ubuntu-latest
needs: create_docs
permissions:
id-token: write # needed to publish to Azure
environment: ${{ inputs.environment }}
if: ${{ inputs.publish }}
runs-on: ubuntu-latest
steps:
- name: Download docs artifact
uses: actions/download-artifact@v3
Expand Down
13 changes: 7 additions & 6 deletions .github/workflows/publish-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ on:
required: false
default: true
type: boolean
repository:
environment:
description: 'Whether to publish to production PyPI or test PyPI'
required: false
default: pypi
default: prod
type: choice
options: [pypi, testpypi]
options: [prod, test]
ref:
description: 'The git ref to build the package for'
required: false
Expand All @@ -34,10 +34,10 @@ on:
default: true
type: boolean
# choice type only supported for workflow_dispatch, not workflow_call
repository:
environment:
description: 'Whether to publish to production PyPI or test PyPI'
required: false
default: pypi
default: prod
type: string
ref:
description: 'The git ref to build the package for'
Expand Down Expand Up @@ -119,6 +119,7 @@ jobs:
needs: [merge]
permissions:
id-token: write
environment: ${{ inputs.environment }}
if: ${{ inputs.publish }}
runs-on: ubuntu-latest
steps:
Expand All @@ -130,4 +131,4 @@ jobs:
- name: Upload wheels and sdist to package index
uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: ${{ inputs.repository == 'testpypi' && 'https://test.pypi.org/legacy/' || '' }}
repository-url: ${{ inputs.environment == 'test' && 'https://test.pypi.org/legacy/' || '' }}

0 comments on commit 4dde5b0

Please sign in to comment.