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

#17 - Action migration to composite #18

Merged
merged 6 commits into from
Jul 18, 2024

Conversation

miroslavpojer
Copy link
Collaborator

  • Updated action.yml file.
  • Renamed and updated main python file.

Closes #17

- Updated action.yml file.
- Renamed and updated main python file.
@miroslavpojer
Copy link
Collaborator Author

miroslavpojer commented Jul 3, 2024

Release notes:

  • Action migrated to composite type.
  • Renamed main control script.
  • Prepared TODO section with several proposals to follow.

- Remove of node.js related lines from README.md.
…composite

# Conflicts:
#	README.md
#	src/controller.py
#	src/living_documentation_generator.py
Copy link
Collaborator

@MobiTikula MobiTikula left a comment

Choose a reason for hiding this comment

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

Besides the comments I suggest to update .gitignore file.

README.md Outdated Show resolved Hide resolved
action.yml Outdated Show resolved Hide resolved
src/living_documentation_generator.py Show resolved Hide resolved
import sys


def extend_args():
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why we have these extend_args?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In the current solution, we have multiple scripts that share config across system env variables. Here, we define paths in one place in the controller.

@miroslavpojer
Copy link
Collaborator Author

miroslavpojer commented Jul 18, 2024

Besides the comments I suggest to update .gitignore file.

What change do you expect? I do not see any change request.

@MobiTikula
Copy link
Collaborator

I suggest to remove node_modules and /package-lock.json, because they keep ignored files in old versions of project, despite we have a composite action now.

Also I still see index.js in the project, is it intentionally? Composite actions should not use javascript at all via: https://docs.github.com/en/actions/creating-actions/creating-a-composite-action and also example Composite actions.

@miroslavpojer
Copy link
Collaborator Author

I suggest to remove node_modules and /package-lock.json, because they keep ignored files in old versions of project, despite we have a composite action now.

Also I still see index.js in the project, is it intentionally? Composite actions should not use javascript at all via: https://docs.github.com/en/actions/creating-actions/creating-a-composite-action and also example Composite actions.

Great findings. All of them should be fixed.

@miroslavpojer miroslavpojer merged commit 96a1eea into master Jul 18, 2024
3 checks passed
@miroslavpojer miroslavpojer deleted the feature/17-action-migration-to-composite branch July 18, 2024 08:21
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.

Action migration to composite
2 participants