Skip to content

Conversation

@raminqaf
Copy link

@raminqaf raminqaf commented Dec 10, 2021

fixes #5

@yannick-roeder
Copy link
Member

yannick-roeder commented Dec 14, 2021

I think we should separate reusable workflows from composite actions inside the repository. We could use a directory structure like this for example:

actions
  bump-version
  helm-lint
  helm-release
workflows
 python-release-poetry

I would also rename release-python-poetry to python-release-poetry so that future python workflows will be alphabetically sorted together with this one

Additionally we should think about splitting the workflow up into smaller actions, so that individual parts of it can be reused as well

@raminqaf raminqaf marked this pull request as draft December 15, 2021 13:26
@raminqaf raminqaf marked this pull request as ready for review December 15, 2021 19:11
@raminqaf
Copy link
Author

raminqaf commented Dec 15, 2021

@yannick-roeder & @disrupted I applied the changes that we discussed yesterday. The PR is so far ready to review. Before you start the review some notes on the changes:

  • I changed the structure of the repository a bit. The reusable workflows files need to be under this address: .github/workflows/<reusable-workflow-name>.yaml. In other words, the structure looks like this:
    actions
      bump-version
      helm-lint
      helm-release
      ...
    
    .github  
      workflows
       python-release-poetry.yaml
    
  • Besides if we add more reusable workflows in the workflows folder the README.md file is going to get really messy. Any suggestions on how we can organize the workflows in better order?
  • We should also consider creating a tag in the near future (e.g., v1). With this, we can version the composite actions in a proper way.
  • Every composite action or workflow related to Python is starting with the prefix python-. I would like to keep that for the rest of the actions/workflows
  • I also called the workflow from github-playground repo and it seems that everything is working properly. 🎊

Co-authored-by: Salomon Popp <mail@salomonpopp.me>
Co-authored-by: Salomon Popp <mail@salomonpopp.me>
Co-authored-by: Salomon Popp <mail@salomonpopp.me>
Co-authored-by: Salomon Popp <mail@salomonpopp.me>
Copy link
Member

@disrupted disrupted left a comment

Choose a reason for hiding this comment

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

This looks really great! I just commented some minor nitpicks.

@raminqaf raminqaf requested a review from disrupted December 22, 2021 14:21
@disrupted
Copy link
Member

I noticed that the changelog creation is not part of the workflow. Did you leave it out intentionally? Of course this could also be added in a followup, I think that this could be really useful to other projects too.

@yannick-roeder
Copy link
Member

Yes, changelog generation would be nice for other projects as well. I think we can resolve that in a separate issue

…akdata/ci-templates into feature/add-python-release-with-poetry
@raminqaf
Copy link
Author

@disrupted Yeah, I didn't add it here yet since it is complicated action and needs some configuration. I would also instead do it in a separate PR.

Copy link
Member

@disrupted disrupted left a comment

Choose a reason for hiding this comment

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

LGTM

@raminqaf raminqaf dismissed VictorKuenstler’s stale review December 22, 2021 14:41

The changes and reviews are already commited

@raminqaf raminqaf merged commit cf61356 into main Dec 22, 2021
@raminqaf raminqaf deleted the feature/add-python-release-with-poetry branch December 22, 2021 14:42
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.

Add reusable action for releasing python packages with poetry

5 participants