feanil/setup semantic release by feanil · Pull Request #16 · openedx/sample-plugin

feanil · 2025-12-29T19:27:28Z

build: Invert version fetching.
build: Add minimal config needed for python-semantic-release
build: Add a github workflow for python-semantic-release

codecov · 2025-12-29T21:00:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.23%. Comparing base (6035bdf) to head (457eac5).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #16      +/-   ##
==========================================
+ Coverage   88.20%   88.23%   +0.02%     
==========================================
  Files          13       13              
  Lines         407      408       +1     
  Branches       16       16              
==========================================
+ Hits          359      360       +1     
  Misses         40       40              
  Partials        8        8

Flag	Coverage Δ
unittests	`88.23% <ø> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull request overview

This PR sets up automated semantic versioning using python-semantic-release. The changes modernize version management by switching from static version strings to dynamic version fetching via importlib.metadata, and introduce a GitHub Actions workflow to automate the release process.

Migrates from hardcoded __version__ strings to dynamic version retrieval using importlib.metadata.version()
Configures pyproject.toml for python-semantic-release integration
Adds a new GitHub workflow for automated releases and PyPI deployments

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
backend/sample_plugin/init.py	Replaces static version string with dynamic version fetching from package metadata
backend/pyproject.toml	Adds static version field, removes version from dynamic list, and includes semantic_release configuration
backend/docs/conf.py	Migrates documentation config from custom version extraction to importlib.metadata
.github/workflows/release.yml	New workflow for automated semantic releases, GitHub releases, and PyPI deployment
.github/workflows/ci.yml	Adds workflow_call trigger to enable reuse from release workflow

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-29T21:20:01Z

-__version__ = "0.1.0"
+from importlib.metadata import version as get_version
+
+# The name of the package is `opnedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the


There's a typo in the comment. The package name is written as "opnedx-sample-plugin" but should be "openedx-sample-plugin" (missing the 'e' in 'openedx'). This inconsistency could be confusing to developers reading this code.

Suggested change

# The name of the package is `opnedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the

# The name of the package is `openedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the

Copilot · 2025-12-29T21:20:02Z

+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.rst"
+output_format = "rst"


The semantic release configuration appears incomplete. The 'changelog.default_templates' section shown here is not valid configuration syntax for python-semantic-release v8+. The correct configuration should use sections like [tool.semantic_release] with proper options such as version_toml, branch, changelog_file, and build_command. The current configuration with 'changelog.default_templates' and 'output_format' is not recognized by the tool and may cause the release process to fail.

Suggested change

[tool.semantic_release.changelog.default_templates]

changelog_file = "CHANGELOG.rst"

output_format = "rst"

[tool.semantic_release]

version_toml = "pyproject.toml:project.version"

changelog_file = "CHANGELOG.rst"

Copilot · 2025-12-29T21:20:02Z

@@ -0,0 +1,90 @@
+name: Python CI


The workflow name is "Python CI" which is the same as the ci.yml workflow. This creates ambiguity in the GitHub Actions UI where both workflows will appear with identical names. Consider renaming this to something more specific like "Release" or "Python Release" to clearly distinguish it from the CI workflow.

Suggested change

name: Python CI

name: Python Release

Copilot · 2025-12-29T21:20:02Z

+          user: __token__
+          password: ${{ secrets.PYPI_UPLOAD_TOKEN }}


The pypa/gh-action-pypi-publish action is being used with deprecated parameters. The 'user' and 'password' parameters are deprecated in favor of trusted publishing. Since the job already has 'id-token: write' permission configured (line 75), which is required for trusted publishing, the 'user' and 'password' parameters should be removed to use the more secure OIDC-based trusted publisher flow instead of API tokens.

Suggested change

user: __token__

password: ${{ secrets.PYPI_UPLOAD_TOKEN }}

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-02T16:46:10Z

 description = "A sample backend plugin for the Open edX Platform"
 requires-python = ">=3.11"
 license="Apache-2.0"
+version = "0.1.0"


The hardcoded version "0.1.0" conflicts with the semantic release approach. With python-semantic-release, the version should be dynamically managed by the tool. However, since you removed "version" from the dynamic list and added a static version, this creates a situation where semantic-release updates will need to modify the static version field in pyproject.toml. Ensure that your semantic_release configuration (once complete) correctly specifies this location as the version source.

Copilot · 2026-01-02T16:46:11Z

+      - name: Action | Semantic Version Release
+        id: release
+        # Adjust tag with desired version if applicable.
+        uses: python-semantic-release/python-semantic-release@v10.5.3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"
+        working-directory: './backend'


The working-directory key is incorrectly placed. In GitHub Actions, working-directory should be nested under the with block for actions, or under the run key for shell commands, but cannot be placed at the step level for action steps. This will cause a workflow syntax error.

For the semantic release action, if you need to set the working directory, you should use the root_options parameter with the --noop flag or configure it via the pyproject.toml file in the backend directory.

Copilot · 2026-01-02T16:46:11Z

+      - name: Publish | Upload to GitHub Release Assets
+        uses: python-semantic-release/publish-action@v10.5.3
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}
+        working-directory: './backend'


The working-directory key is incorrectly placed at the step level. For the publish-action, this should be nested under the with block if the action supports it, or you may need to handle path resolution differently. This will cause a workflow syntax error.

Copilot · 2026-01-02T16:46:11Z

+          path: dist
+          if-no-files-found: error
+        working-directory: './backend'


The working-directory key is incorrectly placed at the step level. For actions/upload-artifact@v4, this should be removed and the path parameter should be updated to backend/dist to reference the correct directory. This will cause a workflow syntax error.

Suggested change

path: dist

if-no-files-found: error

working-directory: './backend'

path: backend/dist

if-no-files-found: error

Copilot · 2026-01-02T16:46:12Z

+from importlib.metadata import version as get_version
+
+# The name of the package is `openedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the
+# package here so that the version fetching works correctly.  A lot of examples will show using `__package__`.
+__version__ = get_version('openedx-sample-plugin')


The use of importlib.metadata.version() will fail if the package is not installed. This can cause issues during development when working with the package in editable mode or when building documentation. Consider adding a fallback mechanism to handle the case when the package metadata is not available, or wrapping this in a try-except block.

Suggested change

from importlib.metadata import version as get_version

# The name of the package is `openedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the

# package here so that the version fetching works correctly. A lot of examples will show using `__package__`.

__version__ = get_version('openedx-sample-plugin')

from importlib.metadata import PackageNotFoundError, version as get_version

# The name of the package is `openedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the

# package here so that the version fetching works correctly. A lot of examples will show using `__package__`.

try:

__version__ = get_version('openedx-sample-plugin')

except PackageNotFoundError:

__version__ = "0.0.0"

Copilot · 2026-01-02T16:46:12Z

+from importlib.metadata import version as get_version


 REPO_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 sys.path.append(REPO_ROOT)

-VERSION = get_version('../sample_plugin', '__init__.py')
+VERSION = get_version('openedx-sample-plugin')


The use of importlib.metadata.version() will fail if the package is not installed. When building documentation, the package may not be installed yet, which will cause the documentation build to fail. Consider adding a fallback mechanism or wrapping this in a try-except block to handle cases where the package metadata is not available.

Copilot · 2026-01-02T16:46:12Z

+          user: __token__
+          password: ${{ secrets.PYPI_UPLOAD_TOKEN }}


Using username/password authentication with PyPI is deprecated. The workflow is using user: __token__ and password parameters, but with the id-token: write permission already granted, you should use trusted publishing instead. Remove the user and password parameters to use OIDC trusted publishing, which is more secure and doesn't require storing secrets.

Suggested change

user: __token__

password: ${{ secrets.PYPI_UPLOAD_TOKEN }}

A lot of systems expect the version number to be in the package metadata so make that the source of truth and update the code to pull the version variable from there instead of the other way around.

This should release the plugin to PyPI on new merges to main.

feanil force-pushed the feanil/setup-semantic-release branch from 41cd77c to addf512 Compare December 29, 2025 20:55

feanil marked this pull request as ready for review December 29, 2025 21:15

feanil requested a review from Copilot December 29, 2025 21:16

Copilot started reviewing on behalf of feanil December 29, 2025 21:16 View session

Copilot AI reviewed Dec 29, 2025

View reviewed changes

feanil requested a review from Copilot January 2, 2026 16:37

Copilot started reviewing on behalf of feanil January 2, 2026 16:39 View session

Copilot AI reviewed Jan 2, 2026

View reviewed changes

feanil added 3 commits January 2, 2026 13:12

build: Invert version fetching.

7084308

A lot of systems expect the version number to be in the package metadata so make that the source of truth and update the code to pull the version variable from there instead of the other way around.

build: Add minimal config needed for python-semantic-release

a14a91c

build: Add a github workflow for python-semantic-release

457eac5

This should release the plugin to PyPI on new merges to main.

feanil force-pushed the feanil/setup-semantic-release branch from 8f0f5db to 457eac5 Compare January 2, 2026 18:12

feanil merged commit f069b27 into main Jan 2, 2026
8 checks passed

feanil deleted the feanil/setup-semantic-release branch January 2, 2026 18:16

	# The name of the package is `opnedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the
	# The name of the package is `openedx-sample-plugin` but __package__ is `sample_plugin` so we hardcode the name of the

Conversation

feanil commented Dec 29, 2025

Uh oh!

codecov Bot commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Dec 29, 2025 •

edited

Loading