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

WIP: Refactor jira-config-gen Command #163

Closed
wants to merge 6 commits into from

Conversation

calebevans
Copy link
Collaborator

@calebevans calebevans commented Mar 13, 2024

Starting some work on refactoring firewatch to have a better structure, closer to other tools our team supports (openshift-cli-installer, qe-metrics, etc.). This PR refactors only the jira-config-gen command, other PRs will follow.

  • Creates utils/general.py to hold some general utilities
    • Creates the render_jira_config function
    • Creates the get_file_conents function
    • Adds unit tests to test the new functions
  • Removes unneeded "Copyright" comments in modified files (will write a subsequent PR to remove all of these)
  • Moves the Jinja template used for the Jira config from a file to a constant in utils/const.py. Did this to avoid needing to provide a path to the template.

@redhat-qe-bot1
Copy link

Report bugs in Issues

The following are automatically added:

  • Add reviewers from OWNER file (in the root of the repository) under reviewers section.
  • Set PR size label.
  • New issue is created for the PR. (Closed when PR is merged/closed)
  • Run pre-commit if .pre-commit-config.yaml exists in the repo.

Available user actions:

  • To mark PR as WIP comment /wip to the PR, To remove it from the PR comment /wip cancel to the PR.
  • To block merging of PR comment /hold, To un-block merging of PR comment /hold cancel.
  • To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
    verified label removed on each new commit push.
  • To cherry pick a merged PR comment /cherry-pick <target branch to cherry-pick to> in the PR.
    • Multiple target branches can be cherry-picked, separated by spaces. (/cherry-pick branch1 branch2)
    • Cherry-pick will be started when PR is merged
  • To build and push container image command /build-and-push-container in the PR (tag will be the PR number).
  • To add a label by comment use /<label name>, to remove, use /<label name> cancel
  • To assign reviewers based on OWNERS file use /assign-reviewers
  • To check if PR can be merged use /check-can-merge
Supported /retest check runs
Supported labels
  • hold
  • verified
  • wip
  • lgtm

@calebevans
Copy link
Collaborator Author

/wip

@redhat-qe-bot2 redhat-qe-bot2 changed the title WIP Refactor jira-config-gen Command WIP: WIP Refactor jira-config-gen Command Mar 13, 2024
@calebevans calebevans changed the title WIP: WIP Refactor jira-config-gen Command WIP: Refactor jira-config-gen Command Mar 13, 2024
@myakove
Copy link
Collaborator

myakove commented May 1, 2024

@calebevans is this PR still needed?

@calebevans calebevans closed this May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants