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.

Sign up for GitHub

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

Jump to bottom

Feature/19 integrate the managing script and all managing scripts into one #20

Merged
merged 19 commits into from
Jul 19, 2024
Merged

Feature/19 integrate the managing script and all managing scripts into one #20

merged 19 commits into from
Jul 19, 2024

Conversation

miroslavpojer
Copy link
Collaborator

@miroslavpojer miroslavpojer commented Jul 18, 2024 •
edited
Loading

  • Introduced main.py at the root of the project.
  • Merged managing scripts and separate ones.
  • Removed data saving and loading logic.
  • Integrated logging - Fixed logging output from the previous state. No extension was done.

Closes #19

@miroslavpojer
#17 - Action migration to composite
ba2483c 
- Updated action.yml file.
- Renamed and updated main python file.
@miroslavpojer
#17 - Action migration to composite
5ff6dc9 
- Remove of node.js related lines from README.md.
@miroslavpojer
Merge branch 'refs/heads/master' into feature/17-action-migration-to-…
dd4e046 
…composite

# Conflicts:
#	README.md
#	src/controller.py
#	src/living_documentation_generator.py
@miroslavpojer
Fixed problem after merge of master.
b073dc5
@miroslavpojer
Temporary commit/backup of latest changes before merge from master.
fa01591
@miroslavpojer
Merge branch 'refs/heads/master' into feature/19-Integrate-the-managi…
ef0abf9 
…ng-script-and-all-managing-scripts-into-one

# Conflicts:
#	README.md
#	action.yml
#	living_documentation_generator/index.js
#	living_documentation_generator/living_documentation_generator.py
#	src/controller.py
@miroslavpojer miroslavpojer requested a review from Zejnilovic July 18, 2024 08:29
@miroslavpojer
Copy link
Collaborator Author

Release Notes:

  • Introduced new logic to manage Living Documentation generation.
  • Removed no more used/needed code.

@miroslavpojer miroslavpojer marked this pull request as ready for review July 18, 2024 10:04
@miroslavpojer miroslavpojer self-assigned this Jul 18, 2024
MobiTikula
MobiTikula requested changes Jul 18, 2024
View reviewed changes
Copy link
Collaborator

@MobiTikula MobiTikula left a comment •
edited
Loading

Choose a reason for hiding this comment

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

  • run_me.sh should not be in the GH repository. Update .gitignore with correct name.
  • data folder now doesn't have to be part of the .gitignore, since we have just output folder.
  • gh_action.py has two methods, that are not used in the project at all. Probably will be covered in next step of refactoring.
  • Why have we change word fetch into mine. On the other hand somewhere, we still use fetch like fetch_repository_projects.
  • Just in my opinion repository_issue sounds better than repo_issue. But it is not important for this PR

action.yml Outdated Show resolved Hide resolved
living_documentation_generator/action/action_inputs.py Show resolved Hide resolved
living_documentation_generator/action/action_inputs.py Show resolved Hide resolved
main.py Outdated Show resolved Hide resolved
main.py Show resolved Hide resolved
living_documentation_generator/generator.py Outdated Show resolved Hide resolved
living_documentation_generator/generator.py Show resolved Hide resolved
living_documentation_generator/generator.py Outdated Show resolved Hide resolved
living_documentation_generator/generator.py Outdated Show resolved Hide resolved
living_documentation_generator/github_integration/model/consolidated_issue.py Outdated Show resolved Hide resolved
@miroslavpojer
Copy link
Collaborator Author

miroslavpojer commented Jul 18, 2024 •
edited
Loading

run_me.sh should not be in the GH repository. Update .gitignore with correct name.
data folder now doesn't have to be part of the .gitignore, since we have just output folder.
gh_action.py has two methods, that are not used in the project at all. Probably will be covered in next step of refactoring.
Why have we change word fetch into mine. On the other hand somewhere, we still use fetch like fetch_repository_projects.
Just in my opinion repository_issue sounds better than repo_issue. But it is not important for this PR

Changed in commit - 514ba3e.

  • run_me.sh - removed and added to .gitignore
  • data removed from .gitignore
  • gh_action - Yes, all should be used
  • mine renamed back to fetch, there was an idea to do not use fetch us it is used by github library. Let's wait for next PR to see the final result.
  • Yeah, it looks better. Renamed.

MobiTikula
MobiTikula previously approved these changes Jul 19, 2024
View reviewed changes
@MobiTikula MobiTikula self-requested a review July 19, 2024 13:03
@miroslavpojer miroslavpojer merged commit 3b66b3b into master Jul 19, 2024
3 checks passed
@miroslavpojer miroslavpojer deleted the feature/19-Integrate-the-managing-script-and-all-managing-scripts-into-one branch July 19, 2024 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MobiTikula MobiTikula MobiTikula approved these changes

@Zejnilovic Zejnilovic Awaiting requested review from Zejnilovic Zejnilovic is a code owner

Assignees

@miroslavpojer miroslavpojer

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Integrate the managing script and all managing scripts into one
2 participants
@miroslavpojer @MobiTikula