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

Release flow #1

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Release flow #1

merged 3 commits into from
Jan 15, 2025

Conversation

jaenrig-ifx
Copy link
Member

By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---

CONTRIBUTING.md also tells you what to expect in the PR process.

The release script is now refactored for reusability across cores.
The functionality is split in 3 main classes:

  • RelelaseConfig-> Handles the core specific parameters
  • CorePackage-> Handles the generation of the .zip file with all the necessary sources
  • PackageIndex-> Handles the generation of the package index JSON manifest used to install 3rd party cores.

Additionally the PackageVersion supports release versioning and ensures consistency with core metafiles versioning.

With all of them the main function build_release_assets which given a config.yml file and the Arduino core repository will create the core source .zip archive and the JSON package index.
An example of the config.yml file -> https://github.com/Infineon/arduino-core-psoc/blob/reuse-ext-workflow/package/config.yml

And finally, a class PackageParser implement a CLI tool to pass the necessary arguments to the packager.

The CI/CD release support is provided in the .github/workflows/release.py.
Here is also an example of how we can reuse the workflow in the arduino-core-psoc:
https://github.com/Infineon/arduino-core-psoc/blob/reuse-ext-workflow/.github/workflows/release.yml

Some improvements already that can be considered:

  • The config.yml params could be automatically extracted from the repo itself by default. That could make make the config.yml optional.

Copy link

@LinjingZhang LinjingZhang left a comment

Choose a reason for hiding this comment

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

Looks nice!
I didn't look at the details of the code too much, should be ok if it worked in psoc-arduino-core without any problems. 2 small questions

  1. Can you put some of the descriptions in the PR into the readme for easy reading and understanding?
  2. is it possible to release in fork?

@jaenrig-ifx
Copy link
Member Author

Looks nice! I didn't look at the details of the code too much, should be ok if it worked in psoc-arduino-core without any problems. 2 small questions

  1. Can you put some of the descriptions in the PR into the readme for easy reading and understanding?
  2. is it possible to release in fork?
  1. Yep, the documentation is missing. And it should be more user oriented. There is an extra task for this.
  2. You can release from a fork with the proper config.

Copy link

@ramya-subramanyam ramya-subramanyam left a comment

Choose a reason for hiding this comment

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

Nice 👍

@jaenrig-ifx jaenrig-ifx merged commit a78ab12 into main Jan 15, 2025
@jaenrig-ifx jaenrig-ifx deleted the release-flow branch January 15, 2025 08:19
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.

4 participants