Add production release and build documentation workflow files #94
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dianapaula19
changed the title
dianapaula19
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds two new GitHub Actions workflows: one to build and deploy documentation to GitHub Pages upon changes in the doc/ directory, and another to automate the PyPI release process when a new release is published.
- Added a documentation build and deploy workflow triggered on pushes to the master branch affecting the doc/ directory.
- Added a production release workflow that validates the release across multiple Python versions and then builds and publishes the release to PyPI.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/update-docs.yaml | Defines the documentation build and deploy pipeline. |
| .github/workflows/prod-release.yaml | Defines the PyPI release pipeline with validation steps. |
Comments suppressed due to low confidence (2)
.github/workflows/update-docs.yaml:7
- [nitpick] The workflow is set to trigger on pushes to the 'master' branch. Verify that 'master' is indeed the intended branch name, especially if the repository's default branch might be named differently.
branches:
.github/workflows/prod-release.yaml:64
- [nitpick] The build-and-publish job uses a fixed Python version (3.11) while the validate-release job tests multiple versions. Confirm that using 3.11 exclusively for building and publishing is intentional.
python-version: "3.11"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #89 and #90
This PR create two pipelines:
validate-release: validates the release for each of the following python versions: 3.9, 3.10, 3.11, 3.12 (similar to the ci pipeline)build-and-publish: builds the project, validates the files using twine, and published the built files to PyPiThe pipeline is triggered when a new release is created and the second step has to be approved by someone from the pypi env approvers list.