Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: Single workflow for GitHub and Pypi release #3

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

tomassebestik
Copy link
Member

@tomassebestik tomassebestik commented Sep 11, 2024

Description

This PR is adding single workflow that creates release:

  • release on GitHub
  • build packages (python wheels)
  • creates release notes from changelog last released version
  • uploads builds to GitHub release as assets
  • uploads builds to PYPI

Others

  • add default CodeQLworkflow for Python

Notes

@tomassebestik tomassebestik self-assigned this Sep 11, 2024
@tomassebestik tomassebestik marked this pull request as ready for review September 11, 2024 12:06
Copy link

github-actions bot commented Sep 11, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello tomassebestik, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 6e9f122

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

Copy link
Collaborator

@radimkarnis radimkarnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few small notes. Otherwise LGTM!

echo "VERSION=$version" >> $GITHUB_OUTPUT

- name: Install dependencies
run: python -m pip install pip czespressif --upgrade
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this point, you are installing dependencies from the previous version.
I believe it should be python -m pip install pip . --upgrade

**/*.whl
**/*.tar.gz

- name: Push release to Pypi - upload builds to PYPI.org
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick, it should be stylized as PyPI

run: python -m pip install pip czespressif --upgrade

- name: Generate Release notes from Changelog
run: cz changelog ${{ steps.get_version.outputs.VERSION }} --template="RELEASE_NOTES.md.j2" --file-name="Release_notes.md"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: Release_notes.md with a first capital letter seems a little unusual

Comment on lines +22 to +25
- os: macos-12
arch: amd64 # macOS 11 should be used for arm64 (Apple Silicon)
- os: macos-14
arch: amd64 # macOS 11 should be used for arm64 (Apple Silicon)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a bit confused by this, the versions do not seem to match in the comments and code. Another thing is that it seems that it will build for arm64 macOS twice - on version 12 and 14, but not even once for amd64.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants